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:
Serializable
,Iterable<E>
,Collection<E>
,Queue<E>
- Direct Known Subclasses:
UnmodifiableQueue
public abstract class AbstractQueueDecorator<E> extends AbstractCollectionDecorator<E> implements Queue<E>
Decorates anotherQueue
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
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractQueueDecorator()
Constructor only used in deserialization, do not use otherwise.protected
AbstractQueueDecorator(Queue<E> queue)
Constructor that wraps (not copies).
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected 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, isEmpty, iterator, remove, removeAll, retainAll, setCollection, size, toArray, toArray, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
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, toArray
-
-
-
-
Constructor Detail
-
AbstractQueueDecorator
protected AbstractQueueDecorator()
Constructor only used in deserialization, do not use otherwise.
-
AbstractQueueDecorator
protected AbstractQueueDecorator(Queue<E> queue)
Constructor that wraps (not copies).- Parameters:
queue
- the queue to decorate, must not be null- Throws:
NullPointerException
- if queue is null
-
-
Method Detail
-
decorated
protected Queue<E> decorated()
Gets the queue being decorated.- Overrides:
decorated
in classAbstractCollectionDecorator<E>
- Returns:
- the decorated queue
-
-