Package com.google.common.collect

Class ForwardingIterator<T extends @Nullable java.lang.Object>

  • All Implemented Interfaces:
    java.util.Iterator<T>
    Direct Known Subclasses:
    ForwardingListIterator
    @GwtCompatible
public abstract class ForwardingIterator<T extends @Nullable java.lang.Object>
extends ForwardingObject
implements java.util.Iterator<T>
    An iterator which forwards all its method calls to another iterator. Subclasses should override one or more methods to modify the behavior of the backing iterator as desired per the decorator pattern.

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

    Since:
    2.0
    Author:
    Kevin Bourrillion

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected abstract java.util.Iterator<T> delegate()
      Returns the backing delegate instance that methods are forwarded to.
      boolean hasNext()  
      T next()  
      void remove()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Iterator

        forEachRemaining

    • Constructor Detail

    • Method Detail

      • delegate

        protected abstract java.util.Iterator<T> 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 ForwardingObject

      • hasNext

        public boolean hasNext()
        Specified by:
        hasNext in interface java.util.Iterator<T extends @Nullable java.lang.Object>

      • remove

        public void remove()
        Specified by:
        remove in interface java.util.Iterator<T extends @Nullable java.lang.Object>