Package org.apache.commons.collections.iterators

Class ArrayIterator

  • All Implemented Interfaces:
    java.util.Iterator, ResettableIterator
    Direct Known Subclasses:
    ArrayListIterator
    @Deprecated(since="2021-04-30")
public class ArrayIterator
extends java.lang.Object
implements ResettableIterator
    Deprecated.
    Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.
    Implements an Iterator over any array.

    The array can be either an array of object or of primitives. If you know that you have an object array, the ObjectArrayIterator class is a better choice, as it will perform better.

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

    Since:
    Commons Collections 1.0

    • Constructor Summary

      Constructors 
      Constructor Description
      ArrayIterator()
      Deprecated.
      Constructor for use with setArray.
      ArrayIterator​(java.lang.Object array)
      Deprecated.
      Constructs an ArrayIterator that will iterate over the values in the specified array.
      ArrayIterator​(java.lang.Object array, int startIndex)
      Deprecated.
      Constructs an ArrayIterator that will iterate over the values in the specified array from a specific start index.
      ArrayIterator​(java.lang.Object array, int startIndex, int endIndex)
      Deprecated.
      Construct an ArrayIterator that will iterate over a range of values in the specified array.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.Object getArray()
      Deprecated.
      Gets the array that this iterator is iterating over.
      boolean hasNext()
      Deprecated.
      Returns true if there are more elements to return from the array.
      java.lang.Object next()
      Deprecated.
      Returns the next element in the array.
      void remove()
      Deprecated.
      Throws UnsupportedOperationException.
      void reset()
      Deprecated.
      Resets the iterator back to the start index.
      void setArray​(java.lang.Object array)
      Deprecated.
      Sets the array that the ArrayIterator should iterate over.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.util.Iterator

        forEachRemaining

    • Constructor Detail

      • ArrayIterator

        public ArrayIterator()
        Deprecated.
        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.

      • ArrayIterator

        public ArrayIterator​(java.lang.Object array)
        Deprecated.
        Constructs an ArrayIterator that will iterate over the values in the specified array.
        Parameters:
        array - the array to iterate over.
        Throws:
        java.lang.IllegalArgumentException - if array is not an array.
        java.lang.NullPointerException - if array is null

      • ArrayIterator

        public ArrayIterator​(java.lang.Object array,
                     int startIndex)
        Deprecated.
        Constructs an ArrayIterator 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:
        java.lang.IllegalArgumentException - if array is not an array.
        java.lang.NullPointerException - if array is null
        java.lang.IndexOutOfBoundsException - if the index is invalid

      • ArrayIterator

        public ArrayIterator​(java.lang.Object array,
                     int startIndex,
                     int endIndex)
        Deprecated.
        Construct an ArrayIterator 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 to finish iterating at.
        Throws:
        java.lang.IllegalArgumentException - if array is not an array.
        java.lang.NullPointerException - if array is null
        java.lang.IndexOutOfBoundsException - if either index is invalid

    • Method Detail

      • hasNext

        public boolean hasNext()
        Deprecated.
        Returns true if there are more elements to return from the array.
        Specified by:
        hasNext in interface java.util.Iterator
        Returns:
        true if there is a next element to return

      • next

        public java.lang.Object next()
        Deprecated.
        Returns the next element in the array.
        Specified by:
        next in interface java.util.Iterator
        Returns:
        the next element in the array
        Throws:
        java.util.NoSuchElementException - if all the elements in the array have already been returned

      • remove

        public void remove()
        Deprecated.
        Throws UnsupportedOperationException.
        Specified by:
        remove in interface java.util.Iterator
        Throws:
        java.lang.UnsupportedOperationException - always

      • getArray

        public java.lang.Object getArray()
        Deprecated.
        Gets the array that this iterator is iterating over.
        Returns:
        the array this iterator iterates over, or null if the no-arg constructor was used and setArray(Object) has never been called with a valid array.

      • setArray

        public void setArray​(java.lang.Object array)
        Deprecated.
        Sets the array that the ArrayIterator should iterate over.

        If an array has previously been set (using the single-arg constructor or this method) then that array is discarded in favour of this one. Iteration is restarted at the start of the new array. Although this can be used to reset iteration, the reset() method is a more effective choice.

        Parameters:
        array - the array that the iterator should iterate over.
        Throws:
        java.lang.IllegalArgumentException - if array is not an array.
        java.lang.NullPointerException - if array is null

      • reset

        public void reset()
        Deprecated.
        Resets the iterator back to the start index.
        Specified by:
        reset in interface ResettableIterator