| java.lang.Object
 org.apache.commons.collections.iterators.ObjectArrayIterator
All known Subclasses: org.apache.commons.collections.iterators.ObjectArrayListIterator,
| ObjectArrayIterator | | public class ObjectArrayIterator implements Iterator,ResettableIterator(Code) | | An
Iterator over an array of objects.
This iterator does not support
ObjectArrayIterator.remove , as the object array cannot be
structurally modified.
The iterator implements a
ObjectArrayIterator.reset method, allowing the reset of the iterator
back to the start if required.
since:
Commons Collections 3.0
version:
$Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
author:
James Strachan
author:
Mauricio S. Moura
author:
Michael A. Smith
author:
Neil O'Toole
author:
Stephen Colebourne
author:
Phil Steitz |
| Constructor Summary | |
| public | ObjectArrayIterator()
Constructor for use with setArray. | | public | ObjectArrayIterator(Object[] array)
Constructs an ObjectArrayIterator that will iterate over the values in the
specified array. | | public | ObjectArrayIterator(Object array, int start)
Constructs an ObjectArrayIterator that will iterate over the values in the
specified array from a specific start index. | | public | ObjectArrayIterator(Object array, int start, int end)
Construct an ObjectArrayIterator that will iterate over a range of values
in the specified array. |
| Method Summary | |
| public Object[] | getArray()
Gets the array that this iterator is iterating over. | | public int | getEndIndex()
Gets the end index to loop to. | | public int | getStartIndex()
Gets the start index to loop from. | | public boolean | hasNext()
Returns true if there are more elements to return from the array. | | public Object | next()
Returns the next element in the array. | | public void | remove()
Throws
UnsupportedOperationException . | | public void | reset()
Resets the iterator back to the start index. | | public void | setArray(Object[] array)
Sets the array that the ArrayIterator should iterate over. |
| endIndex | | protected int endIndex(Code) | | The end index to loop to
|
| index | | protected int index(Code) | | The current iterator index
|
| startIndex | | protected int startIndex(Code) | | The start index to loop from
|
| ObjectArrayIterator | | public ObjectArrayIterator()(Code) | | Constructor for use with setArray.
Using this constructor, the iterator is equivalent to an empty iterator
until
ObjectArrayIterator.setArray is called to establish the array to iterate over.
|
| ObjectArrayIterator | | public ObjectArrayIterator(Object[] array)(Code) | | Constructs an ObjectArrayIterator that will iterate over the values in the
specified array.
Parameters:
array - the array to iterate over
throws:
NullPointerException - if array is null |
| ObjectArrayIterator | | public ObjectArrayIterator(Object array, int start)(Code) | | Constructs an ObjectArrayIterator that will iterate over the values in the
specified array from a specific start index.
Parameters:
array - the array to iterate over
Parameters:
start - the index to start iterating at
throws:
NullPointerException - if array is null
throws:
IndexOutOfBoundsException - if the start index is out of bounds |
| ObjectArrayIterator | | public ObjectArrayIterator(Object array, int start, int end)(Code) | | Construct an ObjectArrayIterator that will iterate over a range of values
in the specified array.
Parameters:
array - the array to iterate over
Parameters:
start - the index to start iterating at
Parameters:
end - the index (exclusive) to finish iterating at
throws:
IndexOutOfBoundsException - if the start or end index is out of bounds
throws:
IllegalArgumentException - if end index is before the start
throws:
NullPointerException - if array is null |
| getArray | | public Object[] getArray()(Code) | | Gets the array that this iterator is iterating over.
the array this iterator iterates over, or null ifthe no-arg constructor was used and ObjectArrayIterator.setArray has neverbeen called with a valid array. |
| getEndIndex | | public int getEndIndex()(Code) | | Gets the end index to loop to.
the end index |
| getStartIndex | | public int getStartIndex()(Code) | | Gets the start index to loop from.
the start index |
| hasNext | | public boolean hasNext()(Code) | | Returns true if there are more elements to return from the array.
true if there is a next element to return |
| next | | public Object next()(Code) | | Returns the next element in the array.
the next element in the array
throws:
NoSuchElementException - if all the elements in the arrayhave already been returned |
| reset | | public void reset()(Code) | | Resets the iterator back to the start index.
|
| setArray | | public void setArray(Object[] array)(Code) | | Sets the array that the ArrayIterator should iterate over.
This method may only be called once, otherwise an IllegalStateException
will occur.
The
ObjectArrayIterator.reset method can be used to reset the iterator if required.
Parameters:
array - the array that the iterator should iterate over
throws:
IllegalStateException - if the array was set in the constructor
throws:
NullPointerException - if array is null |
|
|