|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.collections.iterators.ObjectArrayIterator
public class ObjectArrayIterator
An Iterator over an array of objects.
This iterator does not support 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 java.lang.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(java.lang.Object[] array)
Constructs an ObjectArrayIterator that will iterate over the values in the specified array. |
|
ObjectArrayIterator(java.lang.Object[] array,
int start)
Constructs an ObjectArrayIterator that will iterate over the values in the specified array from a specific start index. |
|
ObjectArrayIterator(java.lang.Object[] array,
int start,
int end)
Construct an ObjectArrayIterator that will iterate over a range of values in the specified array. |
|
| Method Summary | |
|---|---|
java.lang.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. |
java.lang.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(java.lang.Object[] 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 java.lang.Object[] 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(java.lang.Object[]) is called to establish the array to iterate over.
public ObjectArrayIterator(java.lang.Object[] array)
array - the array to iterate over
java.lang.NullPointerException - if array is null
public ObjectArrayIterator(java.lang.Object[] array,
int start)
array - the array to iterate overstart - the index to start iterating at
java.lang.NullPointerException - if array is null
java.lang.IndexOutOfBoundsException - if the start index is out of bounds
public ObjectArrayIterator(java.lang.Object[] array,
int start,
int end)
array - the array to iterate overstart - the index to start iterating atend - the index (exclusive) to finish iterating at
java.lang.IndexOutOfBoundsException - if the start or end index is out of bounds
java.lang.IllegalArgumentException - if end index is before the start
java.lang.NullPointerException - if array is null| Method Detail |
|---|
public boolean hasNext()
hasNext in interface java.util.Iteratorpublic java.lang.Object next()
next in interface java.util.Iteratorjava.util.NoSuchElementException - if all the elements in the array
have already been returnedpublic void remove()
UnsupportedOperationException.
remove in interface java.util.Iteratorjava.lang.UnsupportedOperationException - alwayspublic java.lang.Object[] getArray()
null if
the no-arg constructor was used and setArray(java.lang.Object[]) has never
been called with a valid array.public void setArray(java.lang.Object[] array)
This method may only be called once, otherwise an IllegalStateException will occur.
The reset() method can be used to reset the iterator if required.
array - the array that the iterator should iterate over
java.lang.IllegalStateException - if the array was set in the constructor
java.lang.NullPointerException - if array is nullpublic int getStartIndex()
public int getEndIndex()
public void reset()
reset in interface ResettableIterator
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||