Class ArrayListIterator<E>

java.lang.Object
org.apache.commons.collections4.iterators.ArrayIterator<E>
org.apache.commons.collections4.iterators.ArrayListIterator<E>
All Implemented Interfaces:
Iterator<E>, ListIterator<E>, OrderedIterator<E>, ResettableIterator<E>, ResettableListIterator<E>

public class ArrayListIterator<E> extends ArrayIterator<E> implements ResettableListIterator<E>
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.

Since:
3.0
See Also:
  • Field Details

    • lastItemIndex

      private 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(java.lang.Object) method.
  • Constructor Details

    • ArrayListIterator

      public ArrayListIterator(Object array)
      Constructs an ArrayListIterator that will iterate over the values in the specified array.
      Parameters:
      array - the array to iterate over
      Throws:
      IllegalArgumentException - if array is not an array.
      NullPointerException - if array is null
    • 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.
      Parameters:
      array - the array to iterate over
      startIndex - the index to start iterating at
      Throws:
      IllegalArgumentException - if array is not an array.
      NullPointerException - if array is null
      IndexOutOfBoundsException - if the start index is out of bounds
    • ArrayListIterator

      public ArrayListIterator(Object array, int startIndex, int endIndex)
      Construct an ArrayListIterator that will iterate over a range of values in the specified array.
      Parameters:
      array - the array to iterate over
      startIndex - the index to start iterating at
      endIndex - the index (exclusive) to finish iterating at
      Throws:
      IllegalArgumentException - if array is not an array.
      IndexOutOfBoundsException - if the start or end index is out of bounds
      IllegalArgumentException - if end index is before the start
      NullPointerException - if array is null
  • Method Details