org.apache.commons.collections.iterators
Class ArrayIterator
java.lang.Object
org.apache.commons.collections.iterators.ArrayIterator
- Iterator
public class ArrayIterator
extends java.lang.Object
implements Iterator
Implements an Iterator
over an array of objects.
ArrayIterator() - Construct an ArrayIterator.
|
ArrayIterator(Object array) - Construct an ArrayIterator that will iterate over the values in the
specified array.
|
ArrayIterator(Object array, int start) - Construct an ArrayIterator that will iterate over the values in the
specified array.
|
ArrayIterator(Object array, int start, int end) - Construct an ArrayIterator that will iterate over the values in the
specified array.
|
Object | getArray() - Retrieves the array that this iterator is iterating over.
|
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 | setArray(Object array) - Changes the array that the ArrayIterator should iterate over.
|
ArrayIterator
public ArrayIterator()
Construct an ArrayIterator. Using this constructor, the iterator is
equivalent to an empty iterator until
setArray(Object)
is
called to establish the array to iterate over.
ArrayIterator
public ArrayIterator(Object array)
Construct an ArrayIterator that will iterate over the values in the
specified array.
array
- the array to iterate over.
ArrayIterator
public ArrayIterator(Object array,
int start)
Construct an ArrayIterator that will iterate over the values in the
specified array.
array
- the array to iterate over.start
- the index to start iterating at.
ArrayIterator
public ArrayIterator(Object array,
int start,
int end)
Construct an ArrayIterator that will iterate over the values in the
specified array.
array
- the array to iterate over.start
- the index to start iterating at.end
- the index to finish iterating at.
getArray
public Object getArray()
Retrieves the array that this iterator is iterating over.
- the array this iterator iterates over, or
null
if
the no-arg constructor was used and setArray(Object)
has never
been called with a valid array.
hasNext
public boolean hasNext()
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()
Returns the next element in the array.
- the next element in the array
remove
public void remove()
Throws UnsupportedOperationException
.
setArray
public void setArray(Object array)
Changes the array that the ArrayIterator should iterate over. If an
array has previously been set (using the single-arg constructor or this
method), that array along with the current iterator position within
that array is discarded in favor of the argument to this method. This
method can be used in combination with
getArray()
to "reset"
the iterator to the beginning of the array:
ArrayIterator iterator = ...
...
iterator.setArray(iterator.getArray());
Note: Using i.setArray(i.getArray()) may throw a NullPointerException
if no array has ever been set for the iterator (see
getArray()
)
array
- the array that the iterator should iterate over.
Copyright © 2001-2004 Apache Software Foundation. Documenation generated ${TODAY}.