org.apache.commons.collections4.queue

Class AbstractQueueDecorator<E>

java.lang.Object

org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>

org.apache.commons.collections4.queue.AbstractQueueDecorator<E>

Type Parameters:

E - the type of the elements in the queue

All Implemented Interfaces:

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

Direct Known Subclasses:

UnmodifiableQueue

public abstract class AbstractQueueDecorator<E>
extends AbstractCollectionDecorator<E>
implements java.util.Queue<E>

Decorates another Queue to provide additional behaviour.

Methods are forwarded directly to the decorated queue.

Since:

4.0

Version:

$Id: AbstractQueueDecorator.java 1477765 2013-04-30 18:37:37Z tn $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID Serialization version

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractQueueDecorator() Constructor only used in deserialization, do not use otherwise.
protected	AbstractQueueDecorator(java.util.Queue<E> queue) Constructor that wraps (not copies).

Method Summary

Modifier and Type	Method and Description
protected java.util.Queue<E>	decorated() Gets the queue being decorated.
E	element()
boolean	offer(E obj)
E	peek()
E	poll()
E	remove()

Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, setCollection, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

serialVersionUID

private static final long serialVersionUID

Serialization version

See Also:

Constant Field Values

Constructor Detail

AbstractQueueDecorator

protected AbstractQueueDecorator()

Constructor only used in deserialization, do not use otherwise.

AbstractQueueDecorator

protected AbstractQueueDecorator(java.util.Queue<E> queue)

Constructor that wraps (not copies).

Parameters:

queue - the queue to decorate, must not be null

Throws:

java.lang.IllegalArgumentException - if list is null

Method Detail

decorated

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

Gets the queue being decorated.

Overrides:

decorated in class AbstractCollectionDecorator<E>

Returns:

the decorated queue

offer

public boolean offer(E obj)

Specified by:

offer in interface java.util.Queue<E>

poll

public E poll()

Specified by:

poll 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>

remove

public E remove()

Specified by:

remove in interface java.util.Queue<E>