org.apache.commons.collections.iterators
Class ArrayListIterator
- Iterator, ListIterator, ResettableIterator, ResettableListIterator
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
remove()
, as the array
cannot be changed in size. The
set(Object)
method is supported however.
$Revision: 1.12 $ $Date: 2004/02/18 00:59:50 $- Neil O'Toole
- Stephen Colebourne
- Phil Steitz
protected int | lastItemIndex - Holds the index of the last item returned by a call to
next()
or previous() .
|
ArrayListIterator() - Constructor for use with
setArray .
|
ArrayListIterator(Object array) - Constructs an ArrayListIterator that will iterate over the values in the
specified array.
|
ArrayListIterator(Object array, int startIndex) - Constructs an ArrayListIterator that will iterate over the values in the
specified array from a specific start index.
|
ArrayListIterator(Object array, int startIndex, int endIndex) - Construct an ArrayListIterator that will iterate over a range of values
in the specified array.
|
void | add(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.
|
Object | next() - Gets the next element from the array.
|
int | nextIndex() - Gets the next index to be retrieved.
|
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(Object o) - Sets the element under the cursor.
|
lastItemIndex
protected int lastItemIndex
Holds the index of the last item returned by a call to
next()
or
previous()
. This is set to
-1
if neither method
has yet been invoked.
lastItemIndex
is used to to implement
the
set(Object)
method.
ArrayListIterator
public ArrayListIterator()
Constructor for use with
setArray
.
Using this constructor, the iterator is equivalent to an empty iterator
until
setArray(Object)
is called to establish the array to iterate over.
ArrayListIterator
public ArrayListIterator(Object array)
Constructs an ArrayListIterator that will iterate over the values in the
specified array.
array
- the array to iterate over
ArrayListIterator
public ArrayListIterator(Object array,
int startIndex)
Constructs an ArrayListIterator that will iterate over the values in the
specified array from a specific start index.
array
- the array to iterate overstartIndex
- the index to start iterating at
ArrayListIterator
public ArrayListIterator(Object array,
int startIndex,
int endIndex)
Construct an ArrayListIterator that will iterate over a range of values
in the specified array.
array
- the array to iterate overstartIndex
- the index to start iterating atendIndex
- the index (exclusive) to finish iterating at
add
public void add(Object o)
This iterator does not support modification of its backing collection, and so will
always throw an UnsupportedOperationException
when this method is invoked.
java.util.ListIterator.set
hasPrevious
public boolean hasPrevious()
Returns true if there are previous elements to return from the array.
- true if there is a previous element to return
next
public Object next()
Gets the next element from the array.
- next in interface ArrayIterator
nextIndex
public int nextIndex()
Gets the next index to be retrieved.
- the index of the item to be retrieved next
previous
public Object previous()
Gets the previous element from the array.
previousIndex
public int previousIndex()
Gets the index of the item to be retrieved if
previous()
is called.
- the index of the item to be retrieved next
set
public void set(Object o)
Sets the element under the cursor.
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.
java.util.ListIterator.set
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.