Class ObjectIterators.AbstractIndexBasedListIterator<K>

  • All Implemented Interfaces:
    BidirectionalIterator<K>, ObjectBidirectionalIterator<K>, ObjectIterator<K>, ObjectListIterator<K>, java.util.Iterator<K>, java.util.ListIterator<K>
    Enclosing class:
    ObjectIterators

    public abstract static class ObjectIterators.AbstractIndexBasedListIterator<K>
    extends ObjectIterators.AbstractIndexBasedIterator<K>
    implements ObjectListIterator<K>
    A skeletal implementation for a list-iterator backed by an index-based data store. High performance concrete implementations (like the main ListIterator of ArrayList) generally should avoid using this and just implement the interface directly, but should be decent for less performance critical implementations.

    This class is only appropriate for sequences that are at most Integer.MAX_VALUE long. If your backing data store can be bigger then this, consider the equivalently named class in the type specific BigListSpliterators class.

    As the abstract methods in this class are used in inner loops, it is generally a good idea to override the class as final as to encourage the JVM to inline them (or alternatively, override the abstract methods as final).

    • Method Detail

      • hasPrevious

        public boolean hasPrevious()
        Description copied from interface: BidirectionalIterator
        Returns whether there is a previous element.
        Specified by:
        hasPrevious in interface BidirectionalIterator<K>
        Specified by:
        hasPrevious in interface java.util.ListIterator<K>
        Returns:
        whether there is a previous element.
        See Also:
        ListIterator.hasPrevious()
      • previous

        public K previous()
        Description copied from interface: BidirectionalIterator
        Returns the previous element from the collection.
        Specified by:
        previous in interface BidirectionalIterator<K>
        Specified by:
        previous in interface java.util.ListIterator<K>
        Returns:
        the previous element from the collection.
        See Also:
        ListIterator.previous()
      • nextIndex

        public int nextIndex()
        Specified by:
        nextIndex in interface java.util.ListIterator<K>
      • previousIndex

        public int previousIndex()
        Specified by:
        previousIndex in interface java.util.ListIterator<K>
      • add

        public void add​(K k)
        Description copied from interface: ObjectListIterator
        Inserts the specified element into the list (optional operation).

        This default implementation just throws an UnsupportedOperationException.

        Specified by:
        add in interface java.util.ListIterator<K>
        Specified by:
        add in interface ObjectListIterator<K>
        Parameters:
        k - the element to insert.
        See Also:
        ListIterator.add(Object)
      • set

        public void set​(K k)
        Description copied from interface: ObjectListIterator
        Replaces the last element returned by Iterator.next() or BidirectionalIterator.previous() with the specified element (optional operation).
        Specified by:
        set in interface java.util.ListIterator<K>
        Specified by:
        set in interface ObjectListIterator<K>
        Parameters:
        k - the element used to replace the last element returned.

        This default implementation just throws an UnsupportedOperationException.

        See Also:
        ListIterator.set(Object)