org.apache.commons.collections.iterators
public class ObjectArrayIterator extends Object implements Iterator, ResettableIterator
This iterator does not support ObjectArrayIterator, as the object array cannot be structurally modified.
The iterator implements a ObjectArrayIterator 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) $
Field Summary | |
---|---|
protected Object[] | array The array |
protected int | endIndex The end index to loop to |
protected int | index The current iterator index |
protected int | startIndex The start index to loop from |
Constructor Summary | |
---|---|
ObjectArrayIterator()
Constructor for use with setArray .
| |
ObjectArrayIterator(Object[] array)
Constructs an ObjectArrayIterator that will iterate over the values in the
specified array.
| |
ObjectArrayIterator(Object[] array, int start)
Constructs an ObjectArrayIterator that will iterate over the values in the
specified array from a specific start index.
| |
ObjectArrayIterator(Object[] array, int start, int end)
Construct an ObjectArrayIterator that will iterate over a range of values
in the specified array.
|
Method Summary | |
---|---|
Object[] | getArray()
Gets the array that this iterator is iterating over.
|
int | getEndIndex()
Gets the end index to loop to.
|
int | getStartIndex()
Gets the start index to loop from.
|
boolean | hasNext()
Returns true if there are more elements to return from the array.
|
Object | next()
Returns the next element in the array.
|
void | remove()
Throws UnsupportedOperationException.
|
void | reset()
Resets the iterator back to the start index. |
void | setArray(Object[] array)
Sets the array that the ArrayIterator should iterate over.
|
setArray
.
Using this constructor, the iterator is equivalent to an empty iterator until ObjectArrayIterator is called to establish the array to iterate over.
Parameters: array the array to iterate over
Throws: NullPointerException if array
is null
Parameters: array the array to iterate over start the index to start iterating at
Throws: NullPointerException if array
is null
IndexOutOfBoundsException if the start index is out of bounds
Parameters: array the array to iterate over start the index to start iterating at end the index (exclusive) to finish iterating at
Throws: IndexOutOfBoundsException if the start or end index is out of bounds IllegalArgumentException if end index is before the start NullPointerException if array
is null
Returns: the array this iterator iterates over, or null
if
the no-arg constructor was used and ObjectArrayIterator has never
been called with a valid array.
Returns: the end index
Returns: the start index
Returns: true if there is a next element to return
Returns: the next element in the array
Throws: NoSuchElementException if all the elements in the array have already been returned
Throws: UnsupportedOperationException always
This method may only be called once, otherwise an IllegalStateException will occur.
The ObjectArrayIterator 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 NullPointerException if array
is null