Class ObjectArrayListIterator

    • Field Detail

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

      • ObjectArrayListIterator

        public ObjectArrayListIterator()
        Constructor for use with setArray.

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

      • ObjectArrayListIterator

        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
      • ObjectArrayListIterator

        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
      • ObjectArrayListIterator

        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
    • Method Detail

      • hasPrevious

        public boolean hasPrevious()
        Returns true if there are previous elements to return from the array.
        Specified by:
        hasPrevious in interface ListIterator
        Returns:
        true if there is a previous element to return
      • nextIndex

        public int nextIndex()
        Gets the next index to be retrieved.
        Specified by:
        nextIndex in interface ListIterator
        Returns:
        the index of the item to be retrieved next
      • previousIndex

        public int previousIndex()
        Gets the index of the item to be retrieved if previous() is called.
        Specified by:
        previousIndex in interface ListIterator
        Returns:
        the index of the item to be retrieved next
      • set

        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.

        Specified by:
        set in interface ListIterator
        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