|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.collections.iterators.ObjectArrayIterator
org.apache.commons.collections.iterators.ObjectArrayListIterator
public class ObjectArrayListIterator
Implements a ListIterator over an array of objects.
This iterator does not support add(java.lang.Object) or ObjectArrayIterator.remove(), as the object array
cannot be structurally modified. The set(java.lang.Object) method is supported however.
The iterator implements a reset() method, allowing the reset of the iterator
back to the start if required.
ObjectArrayIterator,
Iterator,
ListIterator| Field Summary | |
|---|---|
protected int |
lastItemIndex
Holds the index of the last item returned by a call to next()
or previous(). |
| Fields inherited from class org.apache.commons.collections.iterators.ObjectArrayIterator |
|---|
array, endIndex, index, startIndex |
| Constructor Summary | |
|---|---|
ObjectArrayListIterator()
Constructor for use with setArray. |
|
ObjectArrayListIterator(java.lang.Object[] array)
Constructs an ObjectArrayListIterator that will iterate over the values in the specified array. |
|
ObjectArrayListIterator(java.lang.Object[] array,
int start)
Constructs an ObjectArrayListIterator that will iterate over the values in the specified array from a specific start index. |
|
ObjectArrayListIterator(java.lang.Object[] array,
int start,
int end)
Construct an ObjectArrayListIterator that will iterate over a range of values in the specified array. |
|
| Method Summary | |
|---|---|
void |
add(java.lang.Object obj)
This iterator does not support modification of its backing array's size, and so will always throw an UnsupportedOperationException when this method is invoked. |
boolean |
hasPrevious()
Returns true if there are previous elements to return from the array. |
java.lang.Object |
next()
Gets the next element from the array. |
int |
nextIndex()
Gets the next index to be retrieved. |
java.lang.Object |
previous()
Gets the previous element from the array. |
int |
previousIndex()
Gets the index of the item to be retrieved if previous() is called. |
void |
reset()
Resets the iterator back to the start index. |
void |
set(java.lang.Object obj)
Sets the element under the cursor. |
| Methods inherited from class org.apache.commons.collections.iterators.ObjectArrayIterator |
|---|
getArray, getEndIndex, getStartIndex, hasNext, remove, setArray |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected int lastItemIndex
next()
or previous(). This is set to -1 if neither method
has yet been invoked. lastItemIndex is used to to implement the
set(java.lang.Object) method.
| Constructor Detail |
|---|
public ObjectArrayListIterator()
setArray.
Using this constructor, the iterator is equivalent to an empty iterator
until ObjectArrayIterator.setArray(java.lang.Object[]) is called to establish the array to iterate over.
public ObjectArrayListIterator(java.lang.Object[] array)
array - the array to iterate over
java.lang.NullPointerException - if array is null
public ObjectArrayListIterator(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 ObjectArrayListIterator(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 hasPrevious()
hasPrevious in interface java.util.ListIteratorpublic java.lang.Object previous()
previous in interface java.util.ListIteratorjava.util.NoSuchElementException - if there is no previous elementpublic java.lang.Object next()
next in interface java.util.Iteratornext in interface java.util.ListIteratornext in class ObjectArrayIteratorjava.util.NoSuchElementException - if there is no next elementpublic int nextIndex()
nextIndex in interface java.util.ListIteratorpublic int previousIndex()
previous() is called.
previousIndex in interface java.util.ListIteratorpublic void add(java.lang.Object obj)
UnsupportedOperationException when this method is invoked.
add in interface java.util.ListIteratorobj - the object to add
java.lang.UnsupportedOperationException - always thrown.public void set(java.lang.Object obj)
This method sets the element that was returned by the last call
to next() of previous().
Note: ListIterator implementations that support add()
and remove() only allow set() to be called once per call
to next() or previous (see the ListIterator
javadoc for more details). Since this implementation does not support
add() or remove(), set() may be
called as often as desired.
set in interface java.util.ListIteratorobj - the object to set into the array
java.lang.IllegalStateException - if next() has not yet been called.
java.lang.ClassCastException - if the object type is unsuitable for the arraypublic void reset()
reset in interface ResettableIteratorreset in interface ResettableListIteratorreset in class ObjectArrayIterator
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||