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.

This implementation does not forward the hashCode and equals methods through to the backing object, but relies on Object's implementation. This is necessary as some Queue implementations, e.g. LinkedList, have custom a equals implementation for which symmetry can not be preserved. See class javadoc of AbstractCollectionDecorator for more information.

Since:

4.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
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, isEmpty, iterator, remove, removeAll, removeIf, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

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>