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

java.lang.Object
  com.google.common.collect.ForwardingObject
      com.google.common.collect.ForwardingCollection<E>
          com.google.common.collect.ForwardingQueue<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Queue<E>

public abstract class ForwardingQueue<E>
extends ForwardingCollection<E>
implements java.util.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.

Author:

Mike Bostock

See Also:

ForwardingObject, Serialized Form

Constructor Summary

protected

ForwardingQueue(java.util.Queue<E> delegate) Constructs a forwarding queue that forwards to the provided delegate.

Method Summary

protected java.util.Queue<E>	delegate() Returns the backing delegate object.
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, containsAllImpl, containsImpl, isEmpty, iterator, remove, removeAll, removeAllImpl, removeImpl, retainAll, retainAllImpl, size, toArray, toArray, toArrayImpl, toArrayImpl, toStringImpl

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

protected ForwardingQueue(java.util.Queue<E> delegate)

Constructs a forwarding queue that forwards to the provided delegate.

Method Detail

delegate

protected java.util.Queue<E> delegate()

Description copied from class: ForwardingObject

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.

Overrides:

delegate in class ForwardingCollection<E>

offer

public boolean offer(E o)

Specified by:

offer in interface java.util.Queue<E>

poll

public E poll()

Specified by:

poll in interface java.util.Queue<E>

remove

public E remove()

Specified by:

remove in interface java.util.Queue<E>

peek

public E peek()

Specified by:

peek in interface java.util.Queue<E>

element

public E element()

Specified by:

element in interface java.util.Queue<E>