| java.lang.Object
 org.apache.commons.collections.iterators.ArrayIterator
All known Subclasses: org.apache.commons.collections.iterators.ArrayListIterator,
| ArrayIterator | | public class ArrayIterator implements ResettableIterator(Code) | | Implements an
java.util.Iterator Iterator over any array.
The array can be either an array of object or of primitives. If you know
that you have an object array, the
org.apache.commons.collections.iterators.ObjectArrayIterator ObjectArrayIterator class is a better choice, as it will perform better.
The iterator implements a
ArrayIterator.reset method, allowing the reset of
the iterator back to the start if required.
since:
Commons Collections 1.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 |
| Constructor Summary | |
| public | ArrayIterator()
Constructor for use with setArray. | | public | ArrayIterator(Object array)
Constructs an ArrayIterator that will iterate over the values in the
specified array. | | public | ArrayIterator(Object array, int startIndex)
Constructs an ArrayIterator that will iterate over the values in the
specified array from a specific start index. | | public | ArrayIterator(Object array, int startIndex, int endIndex)
Construct an ArrayIterator that will iterate over a range of values
in the specified array. |
| Method Summary | |
| protected void | checkBound(int bound, String type)
Checks whether the index is valid or not. | | public Object | getArray()
Gets the array that this iterator is iterating over. | | 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
|
| ArrayIterator | | public ArrayIterator()(Code) | | Constructor for use with setArray.
Using this constructor, the iterator is equivalent to an empty iterator
until
ArrayIterator.setArray(Object) is called to establish the array to iterate over.
|
| ArrayIterator | | public ArrayIterator(Object array)(Code) | | Constructs an ArrayIterator that will iterate over the values in the
specified array.
Parameters:
array - the array to iterate over.
throws:
IllegalArgumentException - if array is not an array.
throws:
NullPointerException - if array is null |
| ArrayIterator | | public ArrayIterator(Object array, int startIndex)(Code) | | Constructs an ArrayIterator that will iterate over the values in the
specified array from a specific start index.
Parameters:
array - the array to iterate over.
Parameters:
startIndex - the index to start iterating at.
throws:
IllegalArgumentException - if array is not an array.
throws:
NullPointerException - if array is null
throws:
IndexOutOfBoundsException - if the index is invalid |
| ArrayIterator | | public ArrayIterator(Object array, int startIndex, int endIndex)(Code) | | Construct an ArrayIterator that will iterate over a range of values
in the specified array.
Parameters:
array - the array to iterate over.
Parameters:
startIndex - the index to start iterating at.
Parameters:
endIndex - the index to finish iterating at.
throws:
IllegalArgumentException - if array is not an array.
throws:
NullPointerException - if array is null
throws:
IndexOutOfBoundsException - if either index is invalid |
| checkBound | | protected void checkBound(int bound, String type)(Code) | | Checks whether the index is valid or not.
Parameters:
bound - the index to check
Parameters:
type - the index type (for error messages)
throws:
IndexOutOfBoundsException - if the index is invalid |
| 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 ArrayIterator.setArray(Object) has neverbeen called with a valid array. |
| 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.
If an array has previously been set (using the single-arg constructor
or this method) then that array is discarded in favour of this one.
Iteration is restarted at the start of the new array.
Although this can be used to reset iteration, the
ArrayIterator.reset() method
is a more effective choice.
Parameters:
array - the array that the iterator should iterate over.
throws:
IllegalArgumentException - if array is not an array.
throws:
NullPointerException - if array is null |
|
|