public class

ObjectArrayListIterator

extends ObjectArrayIterator
implements ListIterator<E> ResettableListIterator
java.lang.Object
   ↳ org.apache.commons.collections.iterators.ObjectArrayIterator
     ↳ org.apache.commons.collections.iterators.ObjectArrayListIterator

Class Overview

Implements a ListIterator over an array of objects.

This iterator does not support add(E) or remove(), as the object array cannot be structurally modified. The set(E) method is supported however.

The iterator implements a reset() method, allowing the reset of the iterator back to the start if required.

See Also

Summary

Fields
protected int lastItemIndex Holds the index of the last item returned by a call to next() or previous().
[Expand]
Inherited Fields
From class org.apache.commons.collections.iterators.ObjectArrayIterator
Public Constructors
ObjectArrayListIterator()
Constructor for use with setArray.
ObjectArrayListIterator(Object[] array)
Constructs an ObjectArrayListIterator that will iterate over the values in the specified array.
ObjectArrayListIterator(Object[] array, int start)
Constructs an ObjectArrayListIterator that will iterate over the values in the specified array from a specific start index.
ObjectArrayListIterator(Object[] array, int start, int end)
Construct an ObjectArrayListIterator that will iterate over a range of values in the specified array.
Public Methods
void add(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.
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 obj)
Sets the element under the cursor.
[Expand]
Inherited Methods
From class org.apache.commons.collections.iterators.ObjectArrayIterator
From class java.lang.Object
From interface java.util.Iterator
From interface java.util.ListIterator
From interface org.apache.commons.collections.ResettableIterator
From interface org.apache.commons.collections.ResettableListIterator

Fields

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(E) method.

Public Constructors

public ObjectArrayListIterator ()

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.

public ObjectArrayListIterator (Object[] array)

Constructs an ObjectArrayListIterator that will iterate over the values in the specified array.

Parameters
array the array to iterate over
Throws
NullPointerException if array is null

public ObjectArrayListIterator (Object[] array, int start)

Constructs an ObjectArrayListIterator that will iterate over the values in the specified array from a specific start index.

Parameters
array the array to iterate over
start the index to start iterating at
Throws
NullPointerException if array is null
IndexOutOfBoundsException if the start index is out of bounds

public ObjectArrayListIterator (Object[] array, int start, int end)

Construct an ObjectArrayListIterator that will iterate over a range of values in the specified array.

Parameters
array the array to iterate over
start the index to start iterating at
end the index (exclusive) to finish iterating at
Throws
IndexOutOfBoundsException if the start or end index is out of bounds
IllegalArgumentException if end index is before the start
NullPointerException if array is null

Public Methods

public void add (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.

Parameters
obj the object to add
Throws
UnsupportedOperationException always thrown.

public boolean hasPrevious ()

Returns true if there are previous elements to return from the array.

Returns
  • true if there is a previous element to return

public Object next ()

Gets the next element from the array.

Returns
  • the next element
Throws
NoSuchElementException if there is no next element

public int nextIndex ()

Gets the next index to be retrieved.

Returns
  • the index of the item to be retrieved next

public Object previous ()

Gets the previous element from the array.

Returns
  • the previous element
Throws
NoSuchElementException if there is no previous element

public int previousIndex ()

Gets the index of the item to be retrieved if previous() is called.

Returns
  • the index of the item to be retrieved next

public void reset ()

Resets the iterator back to the start index.

public void set (Object obj)

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.

Parameters
obj the object to set into the array
Throws
IllegalStateException if next() has not yet been called.
ClassCastException if the object type is unsuitable for the array