Package org.apache.commons.collections.iterators

Class ObjectArrayIterator

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

    This iterator does not support remove(), as the object array cannot be structurally modified.

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

    Since:
    Commons Collections 3.0

    • Constructor Summary

      Constructors 
      Constructor Description
      ObjectArrayIterator()
      Deprecated.
      Constructor for use with setArray.
      ObjectArrayIterator​(java.lang.Object[] array)
      Deprecated.
      Constructs an ObjectArrayIterator that will iterate over the values in the specified array.
      ObjectArrayIterator​(java.lang.Object[] array, int start)
      Deprecated.
      Constructs an ObjectArrayIterator that will iterate over the values in the specified array from a specific start index.
      ObjectArrayIterator​(java.lang.Object[] array, int start, int end)
      Deprecated.
      Construct an ObjectArrayIterator 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.
      int getEndIndex()
      Deprecated.
      Gets the end index to loop to.
      int getStartIndex()
      Deprecated.
      Gets the start index to loop from.
      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

      • ObjectArrayIterator

        public ObjectArrayIterator()
        Deprecated.
        Constructor for use with setArray.

        Using this constructor, the iterator is equivalent to an empty iterator until setArray(java.lang.Object[]) is called to establish the array to iterate over.

      • ObjectArrayIterator

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

      • ObjectArrayIterator

        public ObjectArrayIterator​(java.lang.Object[] array,
                           int start)
        Deprecated.
        Constructs an ObjectArrayIterator 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:
        java.lang.NullPointerException - if array is null
        java.lang.IndexOutOfBoundsException - if the start index is out of bounds

      • ObjectArrayIterator

        public ObjectArrayIterator​(java.lang.Object[] array,
                           int start,
                           int end)
        Deprecated.
        Construct an ObjectArrayIterator 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:
        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

      • 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(java.lang.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.

        This method may only be called once, otherwise an IllegalStateException will occur.

        The reset() method can be used to reset the iterator if required.

        Parameters:
        array - the array that the iterator should iterate over
        Throws:
        java.lang.IllegalStateException - if the array was set in the constructor
        java.lang.NullPointerException - if array is null

      • getStartIndex

        public int getStartIndex()
        Deprecated.
        Gets the start index to loop from.
        Returns:
        the start index

      • getEndIndex

        public int getEndIndex()
        Deprecated.
        Gets the end index to loop to.
        Returns:
        the end index

      • reset

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