Class ForwardingIterator<T>

java.lang.Object
com.google.common.collect.ForwardingObject
com.google.common.collect.ForwardingIterator<T>
All Implemented Interfaces:
Iterator<T>
Direct Known Subclasses:
ForwardingListIterator

public abstract class ForwardingIterator<T> extends ForwardingObject implements 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
  • Constructor Details

    • ForwardingIterator

      protected ForwardingIterator()
      Constructor for use by subclasses.
  • Method Details

    • delegate

      protected abstract 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 Iterator<T>
    • next

      public T next()
      Specified by:
      next in interface Iterator<T>
    • remove

      public void remove()
      Specified by:
      remove in interface Iterator<T>