Package com.google.common.collect
Class ForwardingIterator<T extends @Nullable Object>
- java.lang.Object
-
- com.google.common.collect.ForwardingObject
-
- com.google.common.collect.ForwardingIterator<T>
-
- All Implemented Interfaces:
Iterator<T>
- Direct Known Subclasses:
ForwardingListIterator
@GwtCompatible public abstract class ForwardingIterator<T extends @Nullable Object> 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 somedefault
methods. Specifically, it forwards calls only for methods that existed beforedefault
methods were introduced. For newer methods, likeforEachRemaining
, it inherits their default implementations. When those implementations invoke methods, they invoke methods on theForwardingIterator
.- 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 Iterator<T>
delegate()
Returns the backing delegate instance that methods are forwarded to.boolean
hasNext()
T
next()
void
remove()
-
Methods inherited from class com.google.common.collect.ForwardingObject
toString
-
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
-
ForwardingIterator
protected ForwardingIterator()
Constructor for use by subclasses.
-
-
Method Detail
-
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 asForwardingSet.delegate()
. Concrete subclasses override this method to supply the instance being decorated.- Specified by:
delegate
in classForwardingObject
-
hasNext
public boolean hasNext()
-
next
@CanIgnoreReturnValue public T next()
-
-