com.google.common.collect
Class ForwardingQueue<E>

java.lang.Object
  extended by com.google.common.collect.ForwardingObject
      extended by com.google.common.collect.ForwardingCollection<E>
          extended by com.google.common.collect.ForwardingQueue<E>
All Implemented Interfaces:
Iterable<E>, Collection<E>, Queue<E>

public abstract class ForwardingQueue<E>
extends ForwardingCollection<E>
implements Queue<E>

A queue which forwards all its method calls to another queue. Subclasses should override one or more methods to modify the behavior of the backing queue as desired per the decorator pattern.

Since:
2010.01.04 stable (imported from Google Collections Library)
Author:
Mike Bostock
See Also:
ForwardingObject

Constructor Summary
ForwardingQueue()
           
 
Method Summary
protected abstract  Queue<E> delegate()
          Returns the backing delegate instance that methods are forwarded to.
 E element()
           
 boolean offer(E o)
           
 E peek()
           
 E poll()
           
 E remove()
           
 
Methods inherited from class com.google.common.collect.ForwardingCollection
add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
 
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.Queue
add
 
Methods inherited from interface java.util.Collection
addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
 

Constructor Detail

ForwardingQueue

public ForwardingQueue()
Method Detail

delegate

protected abstract Queue<E> 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 ForwardingCollection<E>

offer

public boolean offer(E o)
Specified by:
offer in interface Queue<E>

poll

public E poll()
Specified by:
poll in interface Queue<E>

remove

public E remove()
Specified by:
remove in interface Queue<E>

peek

public E peek()
Specified by:
peek in interface Queue<E>

element

public E element()
Specified by:
element in interface Queue<E>