|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.commons.collections.iterators.ArrayIterator
Implements an Iterator
over an array of objects.
Constructor Summary | |
ArrayIterator()
Construct an ArrayIterator. |
|
ArrayIterator(java.lang.Object array)
Construct an ArrayIterator that will iterate over the values in the specified array. |
|
ArrayIterator(java.lang.Object array,
int start)
Construct an ArrayIterator that will iterate over the values in the specified array. |
|
ArrayIterator(java.lang.Object array,
int start,
int end)
Construct an ArrayIterator that will iterate over the values in the specified array. |
Method Summary | |
java.lang.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. |
java.lang.Object |
next()
Returns the next element in the array. |
void |
remove()
Throws UnsupportedOperationException . |
void |
setArray(java.lang.Object array)
Changes the array that the ArrayIterator should iterate over. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ArrayIterator()
setArray(Object)
is
called to establish the array to iterate over.
public ArrayIterator(java.lang.Object array)
array
- the array to iterate over.
java.lang.IllegalArgumentException
- if array
is not an
array.
java.lang.NullPointerException
- if array
is null
public ArrayIterator(java.lang.Object array, int start)
array
- the array to iterate over.start
- the index to start iterating at.
java.lang.IllegalArgumentException
- if array
is not an
array.
java.lang.NullPointerException
- if array
is null
public ArrayIterator(java.lang.Object array, int start, int end)
array
- the array to iterate over.start
- the index to start iterating at.end
- the index to finish iterating at.
java.lang.IllegalArgumentException
- if array
is not an
array.
java.lang.NullPointerException
- if array
is null
Method Detail |
public boolean hasNext()
hasNext
in interface java.util.Iterator
public java.lang.Object next()
next
in interface java.util.Iterator
java.util.NoSuchElementException
- if all the elements in the array
have already been returnedpublic void remove()
UnsupportedOperationException
.
remove
in interface java.util.Iterator
java.lang.UnsupportedOperationException
- alwayspublic java.lang.Object getArray()
null
if
the no-arg constructor was used and setArray(Object)
has never
been called with a valid array.public void setArray(java.lang.Object array)
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.
java.lang.IllegalArgumentException
- if array
is not an
array.
java.lang.NullPointerException
- if array
is null
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |