|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.collections.iterators.ObjectArrayIterator<E>
public class ObjectArrayIterator<E>
An Iterator
over an array of objects.
remove()
, as the object array cannot be
structurally modified.
The iterator implements a reset()
method, allowing the reset of the iterator
back to the start if required.
Field Summary | |
---|---|
protected E[] |
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(E[] array)
Constructs an ObjectArrayIterator that will iterate over the values in the specified array. |
|
ObjectArrayIterator(E[] array,
int start)
Constructs an ObjectArrayIterator that will iterate over the values in the specified array from a specific start index. |
|
ObjectArrayIterator(E[] array,
int start,
int end)
Construct an ObjectArrayIterator that will iterate over a range of values in the specified array. |
Method Summary | |
---|---|
E[] |
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. |
E |
next()
Returns the next element in the array. |
void |
remove()
Throws UnsupportedOperationException . |
void |
reset()
Resets the iterator back to the start index. |
void |
setArray(E[] array)
Sets the array that the ArrayIterator should iterate over. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected E[] array
protected int startIndex
protected int endIndex
protected int index
Constructor Detail |
---|
public ObjectArrayIterator()
setArray
.
Using this constructor, the iterator is equivalent to an empty iterator
until setArray(E[])
is called to establish the array to iterate over.
public ObjectArrayIterator(E[] array)
array
- the array to iterate over
NullPointerException
- if array
is null
public ObjectArrayIterator(E[] array, int start)
array
- the array to iterate overstart
- the index to start iterating at
NullPointerException
- if array
is null
IndexOutOfBoundsException
- if the start index is out of boundspublic ObjectArrayIterator(E[] array, int start, int end)
array
- the array to iterate overstart
- the index to start iterating atend
- the index (exclusive) to finish iterating at
IndexOutOfBoundsException
- if the start or end index is out of bounds
IllegalArgumentException
- if end index is before the start
NullPointerException
- if array
is null
Method Detail |
---|
public boolean hasNext()
hasNext
in interface Iterator<E>
public E next()
next
in interface Iterator<E>
NoSuchElementException
- if all the elements in the array
have already been returnedpublic void remove()
UnsupportedOperationException
.
remove
in interface Iterator<E>
UnsupportedOperationException
- alwayspublic E[] getArray()
null
if
the no-arg constructor was used and setArray(E[])
has never
been called with a valid array.public void setArray(E[] array)
reset()
method can be used to reset the iterator if required.
array
- the array that the iterator should iterate over
IllegalStateException
- if the array
was set in the constructor
NullPointerException
- if array
is null
public int getStartIndex()
public int getEndIndex()
public void reset()
reset
in interface ResettableIterator<E>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |