Package com.google.common.collect

Class ForwardingListIterator<E>

  • All Implemented Interfaces:
    <E>, <E>
    @GwtCompatible
public abstract class ForwardingListIterator<E>
extends ForwardingIterator<E>
implements <E>
    A list iterator which forwards all its method calls to another list iterator. Subclasses should override one or more methods to modify the behavior of the backing iterator as desired per the .

    default method warning: This class forwards calls to only some default methods. Specifically, it forwards calls only for methods that existed . For newer methods, like forEachRemaining, it inherits their default implementations. When those implementations invoke methods, they invoke methods on the ForwardingListIterator.

    Since:
    2.0
    Author:
    Mike Bostock

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected ForwardingListIterator()
      Constructor for use by subclasses.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(E element)
      Inserts the specified element into the list (optional operation).
      protected abstract <E> delegate()
      Returns the backing delegate instance that methods are forwarded to.
      boolean hasPrevious()
      Returns true if this list iterator has more elements when traversing the list in the reverse direction.
      int nextIndex()
      Returns the index of the element that would be returned by a subsequent call to .
      E previous()
      Returns the previous element in the list and moves the cursor position backwards.
      int previousIndex()
      Returns the index of the element that would be returned by a subsequent call to .
      void set​(E element)
      Replaces the last element returned by or with the specified element (optional operation).

      • Methods inherited from class java.lang.

        , , , , , , , , ,

      • Methods inherited from interface java.util.

      • Methods inherited from interface java.util.

        , ,

    • Method Detail

      • delegate

        protected abstract <E> delegate()
        Description copied from class: ForwardingObject
        Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.
        Specified by:
        delegate in class ForwardingIterator<E>

      • add

        public void add​(E element)
        Description copied from interface: 
        Inserts the specified element into the list (optional operation). The element is inserted immediately before the element that would be returned by , if any, and after the element that would be returned by , if any. (If the list contains no elements, the new element becomes the sole element on the list.) The new element is inserted before the implicit cursor: a subsequent call to next would be unaffected, and a subsequent call to previous would return the new element. (This call increases by one the value that would be returned by a call to nextIndex or previousIndex.)
        Specified by:
         in interface <E>
        Parameters:
        element - the element to insert

      • hasPrevious

        public boolean hasPrevious()
        Description copied from interface: 
        Returns true if this list iterator has more elements when traversing the list in the reverse direction. (In other words, returns true if would return an element rather than throwing an exception.)
        Specified by:
         in interface <E>
        Returns:
        true if the list iterator has more elements when traversing the list in the reverse direction

      • nextIndex

        public int nextIndex()
        Description copied from interface: 
        Returns the index of the element that would be returned by a subsequent call to . (Returns list size if the list iterator is at the end of the list.)
        Specified by:
         in interface <E>
        Returns:
        the index of the element that would be returned by a subsequent call to next, or list size if the list iterator is at the end of the list

      • previous

        public E previous()
        Description copied from interface: 
        Returns the previous element in the list and moves the cursor position backwards. This method may be called repeatedly to iterate through the list backwards, or intermixed with calls to to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)
        Specified by:
         in interface <E>
        Returns:
        the previous element in the list

      • previousIndex

        public int previousIndex()
        Description copied from interface: 
        Returns the index of the element that would be returned by a subsequent call to . (Returns -1 if the list iterator is at the beginning of the list.)
        Specified by:
         in interface <E>
        Returns:
        the index of the element that would be returned by a subsequent call to previous, or -1 if the list iterator is at the beginning of the list

      • set

        public void set​(E element)
        Description copied from interface: 
        Replaces the last element returned by or with the specified element (optional operation). This call can be made only if neither nor have been called after the last call to next or previous.
        Specified by:
         in interface <E>
        Parameters:
        element - the element with which to replace the last element returned by next or previous