- All Implemented Interfaces:
- Direct Known Subclasses:
@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.
defaultmethod warning: This class forwards calls to only some
defaultmethods. Specifically, it forwards calls only for methods that existed before
defaultmethods were introduced. For newer methods, like
forEachRemaining, it inherits their default implementations. When those implementations invoke methods, they invoke methods on the
- Kevin Bourrillion
Constructors Modifier Constructor Description
ForwardingIterator()Constructor for use by subclasses.
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.
trueif the iteration has more elements.
next()Returns the next element in the iteration.
remove()Removes from the underlying collection the last element returned by this iterator (optional operation).
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
protected ForwardingIterator()Constructor for use by subclasses.
delegateDescription copied from class:
ForwardingObjectReturns 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.
public boolean hasNext()Returns
trueif the iteration has more elements. (In other words, returns
Iterator.next()would return an element rather than throwing an exception.)
@CanIgnoreReturnValue public T next()Returns the next element in the iteration.
public void remove()Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to
The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.
The behavior of an iterator is unspecified if this method is called after a call to the