|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.collections.iterators.ArrayIterator
org.apache.commons.collections.iterators.ArrayListIterator
public class ArrayListIterator
Implements a ListIterator over an array.
The array can be either an array of object or of primitives. If you know
that you have an object array, the ObjectArrayListIterator
class is a better choice, as it will perform better.
This iterator does not support add(Object) or ArrayIterator.remove(), as the array
cannot be changed in size. The set(Object) method is supported however.
ArrayIterator,
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.ArrayIterator |
|---|
array, endIndex, index, startIndex |
| Constructor Summary | |
|---|---|
ArrayListIterator()
Constructor for use with setArray. |
|
ArrayListIterator(java.lang.Object array)
Constructs an ArrayListIterator that will iterate over the values in the specified array. |
|
ArrayListIterator(java.lang.Object array,
int startIndex)
Constructs an ArrayListIterator that will iterate over the values in the specified array from a specific start index. |
|
ArrayListIterator(java.lang.Object array,
int startIndex,
int endIndex)
Construct an ArrayListIterator that will iterate over a range of values in the specified array. |
|
| Method Summary | |
|---|---|
void |
add(java.lang.Object o)
This iterator does not support modification of its backing collection, 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 o)
Sets the element under the cursor. |
| Methods inherited from class org.apache.commons.collections.iterators.ArrayIterator |
|---|
checkBound, getArray, 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 ArrayListIterator()
setArray.
Using this constructor, the iterator is equivalent to an empty iterator
until ArrayIterator.setArray(Object) is called to establish the array to iterate over.
public ArrayListIterator(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 ArrayListIterator(java.lang.Object array,
int startIndex)
array - the array to iterate overstartIndex - the index to start iterating at
java.lang.IllegalArgumentException - if array is not an array.
java.lang.NullPointerException - if array is null
java.lang.IndexOutOfBoundsException - if the start index is out of bounds
public ArrayListIterator(java.lang.Object array,
int startIndex,
int endIndex)
array - the array to iterate overstartIndex - the index to start iterating atendIndex - the index (exclusive) to finish iterating at
java.lang.IllegalArgumentException - if array is not an array.
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 ArrayIteratorjava.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 o)
UnsupportedOperationException when this method is invoked.
add in interface java.util.ListIteratorjava.lang.UnsupportedOperationException - always thrown.ListIterator.set(java.lang.Object)public void set(java.lang.Object o)
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.ListIteratorListIterator.set(java.lang.Object)public void reset()
reset in interface ResettableIteratorreset in interface ResettableListIteratorreset in class ArrayIterator
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||