com.google.common.collect
Class ForwardingIterator<T>

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

public abstract class ForwardingIterator<T>
extends Object
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.

Unlike most Forwarding classes, this class does not implement Serializable, since iterators are rarely serialized.

Author:
Kevin Bourrillion
See Also:
ForwardingObject

Constructor Summary
protected ForwardingIterator(Iterator<T> delegate)
          Constructs a forwarding iterator that forwards to the provided delegate.
 
Method Summary
protected  Iterator<T> delegate()
          Returns the backing delegate object.
 boolean hasNext()
           
 T next()
           
 void remove()
           
 String toString()
          Returns the string representation generated by the delegate's toString method.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ForwardingIterator

protected ForwardingIterator(Iterator<T> delegate)
Constructs a forwarding iterator that forwards to the provided delegate.

Method Detail

delegate

protected Iterator<T> delegate()
Returns the backing delegate object. This method should be overridden to specify the correct return type. For example:
  @SuppressWarnings("unchecked")
  @Override protected Foo delegate() {
    return (Foo) super.delegate();
  }
This method should always return the same delegate instance that was passed to the constructor.


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>

toString

public String toString()
Returns the string representation generated by the delegate's toString method.

Overrides:
toString in class Object