Class SynchronizedQueue<E>
java.lang.Object
org.apache.commons.collections4.collection.SynchronizedCollection<E>
org.apache.commons.collections4.queue.SynchronizedQueue<E>
- Type Parameters:
E- the type of the elements in the collection
- All Implemented Interfaces:
Serializable,Iterable<E>,Collection<E>,Queue<E>
Decorates another
Queue to synchronize its behaviour for a multi-threaded environment.
Methods are synchronized, then forwarded to the decorated queue. Iterators must be separately synchronized around the loop.
- Since:
- 4.2
- See Also:
-
Field Summary
Fields inherited from class org.apache.commons.collections4.collection.SynchronizedCollection
lock -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedSynchronizedQueue(Queue<E> queue) Constructor that wraps (not copies).protectedSynchronizedQueue(Queue<E> queue, Object lock) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionGets the queue being decorated.element()booleaninthashCode()booleanpeek()poll()remove()static <E> SynchronizedQueue<E>synchronizedQueue(Queue<E> queue) Factory method to create a synchronized queue.Methods inherited from class org.apache.commons.collections4.collection.SynchronizedCollection
add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, synchronizedCollection, toArray, toArray, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Constructor Details
-
SynchronizedQueue
Constructor that wraps (not copies).- Parameters:
queue- the queue to decorate, must not be null- Throws:
NullPointerException- if queue is null
-
SynchronizedQueue
Constructor that wraps (not copies).- Parameters:
queue- the queue to decorate, must not be nulllock- the lock to use, must not be null- Throws:
NullPointerException- if queue or lock is null
-
-
Method Details
-
synchronizedQueue
Factory method to create a synchronized queue.- Type Parameters:
E- the type of the elements in the queue- Parameters:
queue- the queue to decorate, must not be null- Returns:
- a new synchronized Queue
- Throws:
NullPointerException- if queue is null
-
decorated
Gets the queue being decorated.- Overrides:
decoratedin classSynchronizedCollection<E>- Returns:
- the decorated queue
-
element
-
equals
- Specified by:
equalsin interfaceCollection<E>- Overrides:
equalsin classSynchronizedCollection<E>
-
hashCode
- Specified by:
hashCodein interfaceCollection<E>- Overrides:
hashCodein classSynchronizedCollection<E>
-
offer
-
peek
-
poll
-
remove
-