E
- the type of elements held in this dequeSerializable
, Iterable<E>
, Collection<E>
, Deque<E>
, Queue<E>
, SequencedCollection<E>
public class ConcurrentLinkedDeque<E> extends AbstractCollection<E> implements Deque<E>, Serializable
ConcurrentLinkedDeque
is an appropriate choice when many threads will share access to a common collection. Like most other concurrent collection implementations, this class does not permit the use of null
elements. Iterators and spliterators are weakly consistent.
Beware that, unlike in most collections, the size
method is NOT a constant-time operation. Because of the asynchronous nature of these deques, determining the current number of elements requires a traversal of the elements, and so may report inaccurate results if this collection is modified during traversal.
Bulk operations that add, remove, or examine multiple elements, such as addAll(java.util.Collection<? extends E>)
, removeIf(java.util.function.Predicate<? super E>)
or forEach(java.util.function.Consumer<? super E>)
, are not guaranteed to be performed atomically. For example, a forEach
traversal concurrent with an
addAll
operation might observe only some of the added elements.
This class and its iterator implement all of the optional methods of the Deque
and Iterator
interfaces.
Memory consistency effects: As with other concurrent collections, actions in a thread prior to placing an object into a ConcurrentLinkedDeque
happen-before actions subsequent to the access or removal of that element from the ConcurrentLinkedDeque
in another thread.
This class is a member of the Java Collections Framework.
Constructor | Description |
---|---|
ConcurrentLinkedDeque() |
Constructs an empty deque. |
ConcurrentLinkedDeque |
Constructs a deque initially containing the elements of the given collection, added in traversal order of the collection's iterator. |
Modifier and Type | Method | Description |
---|---|---|
boolean |
add |
Inserts the specified element at the tail of this deque. |
boolean |
addAll |
Appends all of the elements in the specified collection to the end of this deque, in the order that they are returned by the specified collection's iterator. |
void |
addFirst |
Inserts the specified element at the front of this deque. |
void |
addLast |
Inserts the specified element at the end of this deque. |
void |
clear() |
Removes all of the elements from this deque. |
boolean |
contains |
Returns true if this deque contains the specified element. |
Iterator |
descendingIterator() |
Returns an iterator over the elements in this deque in reverse sequential order. |
E |
element() |
Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque). |
void |
forEach |
Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception. |
E |
getFirst() |
Retrieves, but does not remove, the first element of this deque. |
E |
getLast() |
Retrieves, but does not remove, the last element of this deque. |
boolean |
isEmpty() |
Returns true if this collection contains no elements. |
Iterator |
iterator() |
Returns an iterator over the elements in this deque in proper sequence. |
boolean |
offer |
Inserts the specified element at the tail of this deque. |
boolean |
offerFirst |
Inserts the specified element at the front of this deque. |
boolean |
offerLast |
Inserts the specified element at the end of this deque. |
E |
peek() |
Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque), or returns null if this deque is empty. |
E |
peekFirst() |
Retrieves, but does not remove, the first element of this deque, or returns null if this deque is empty. |
E |
peekLast() |
Retrieves, but does not remove, the last element of this deque, or returns null if this deque is empty. |
E |
poll() |
Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns null if this deque is empty. |
E |
pollFirst() |
Retrieves and removes the first element of this deque, or returns null if this deque is empty. |
E |
pollLast() |
Retrieves and removes the last element of this deque, or returns null if this deque is empty. |
E |
pop() |
Pops an element from the stack represented by this deque. |
void |
push |
Pushes an element onto the stack represented by this deque (in other words, at the head of this deque) if it is possible to do so immediately without violating capacity restrictions, throwing an IllegalStateException if no space is currently available. |
E |
remove() |
Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque). |
boolean |
remove |
Removes the first occurrence of the specified element from this deque. |
boolean |
removeAll |
Removes all of this collection's elements that are also contained in the specified collection (optional operation). |
E |
removeFirst() |
Retrieves and removes the first element of this deque. |
boolean |
removeFirstOccurrence |
Removes the first occurrence of the specified element from this deque. |
boolean |
removeIf |
Removes all of the elements of this collection that satisfy the given predicate. |
E |
removeLast() |
Retrieves and removes the last element of this deque. |
boolean |
removeLastOccurrence |
Removes the last occurrence of the specified element from this deque. |
boolean |
retainAll |
Retains only the elements in this collection that are contained in the specified collection (optional operation). |
int |
size() |
Returns the number of elements in this deque. |
Spliterator |
spliterator() |
Returns a Spliterator over the elements in this deque. |
Object[] |
toArray() |
Returns an array containing all of the elements in this deque, in proper sequence (from first to last element). |
<T> T[] |
toArray |
Returns an array containing all of the elements in this deque, in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. |
containsAll, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
containsAll, equals, hashCode, parallelStream, stream, toArray
public ConcurrentLinkedDeque()
public ConcurrentLinkedDeque(Collection<? extends E> c)
c
- the collection of elements to initially containNullPointerException
- if the specified collection or any of its elements are nullpublic void addFirst(E e)
IllegalStateException
.addFirst
in interface Deque<E>
addFirst
in interface SequencedCollection<E>
e
- the element to addNullPointerException
- if the specified element is nullpublic void addLast(E e)
IllegalStateException
. This method is equivalent to add(E)
.
addLast
in interface Deque<E>
addLast
in interface SequencedCollection<E>
e
- the element to addNullPointerException
- if the specified element is nullpublic boolean offerFirst(E e)
false
.offerFirst
in interface Deque<E>
e
- the element to addtrue
(as specified by Deque.offerFirst(E)
)NullPointerException
- if the specified element is nullpublic boolean offerLast(E e)
false
. This method is equivalent to add(E)
.
offerLast
in interface Deque<E>
e
- the element to addtrue
(as specified by Deque.offerLast(E)
)NullPointerException
- if the specified element is nullpublic E peekFirst()
Deque
null
if this deque is empty.public E peekLast()
Deque
null
if this deque is empty.public E getFirst()
Deque
peekFirst
only in that it throws an exception if this deque is empty.getFirst
in interface Deque<E>
getFirst
in interface SequencedCollection<E>
NoSuchElementException
- if this deque is emptypublic E getLast()
Deque
peekLast
only in that it throws an exception if this deque is empty.getLast
in interface Deque<E>
getLast
in interface SequencedCollection<E>
NoSuchElementException
- if this deque is emptypublic E pollFirst()
Deque
null
if this deque is empty.public E pollLast()
Deque
null
if this deque is empty.public E removeFirst()
Deque
pollFirst
only in that it throws an exception if this deque is empty.removeFirst
in interface Deque<E>
removeFirst
in interface SequencedCollection<E>
NoSuchElementException
- if this deque is emptypublic E removeLast()
Deque
pollLast
only in that it throws an exception if this deque is empty.removeLast
in interface Deque<E>
removeLast
in interface SequencedCollection<E>
NoSuchElementException
- if this deque is emptypublic boolean offer(E e)
false
.offer
in interface Deque<E>
offer
in interface Queue<E>
e
- the element to addtrue
(as specified by Queue.offer(E)
)NullPointerException
- if the specified element is nullpublic boolean add(E e)
IllegalStateException
or return false
.add
in interface Collection<E>
add
in interface Deque<E>
add
in interface Queue<E>
add
in class AbstractCollection<E>
e
- element whose presence in this collection is to be ensuredtrue
(as specified by Collection.add(E)
)NullPointerException
- if the specified element is nullpublic E poll()
Deque
null
if this deque is empty. This method is equivalent to Deque.pollFirst()
.
public E peek()
Deque
null
if this deque is empty. This method is equivalent to Deque.peekFirst()
.
public E remove()
Deque
poll()
only in that it throws an exception if this deque is empty. This method is equivalent to Deque.removeFirst()
.
public E pop()
Deque
This method is equivalent to Deque.removeFirst()
.
pop
in interface Deque<E>
NoSuchElementException
- if this deque is emptypublic E element()
Deque
peek
only in that it throws an exception if this deque is empty. This method is equivalent to Deque.getFirst()
.
public void push(E e)
Deque
IllegalStateException
if no space is currently available. This method is equivalent to Deque.addFirst(E)
.
push
in interface Deque<E>
e
- the element to pushNullPointerException
- if the specified element is null and this deque does not permit null elementspublic boolean removeFirstOccurrence(Object o)
e
such that o.equals(e)
(if such an element exists). Returns true
if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).removeFirstOccurrence
in interface Deque<E>
o
- element to be removed from this deque, if presenttrue
if the deque contained the specified elementNullPointerException
- if the specified element is nullpublic boolean removeLastOccurrence(Object o)
e
such that o.equals(e)
(if such an element exists). Returns true
if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).removeLastOccurrence
in interface Deque<E>
o
- element to be removed from this deque, if presenttrue
if the deque contained the specified elementNullPointerException
- if the specified element is nullpublic boolean contains(Object o)
true
if this deque contains the specified element. More formally, returns true
if and only if this deque contains at least one element e
such that o.equals(e)
.contains
in interface Collection<E>
contains
in interface Deque<E>
contains
in class AbstractCollection<E>
o
- element whose presence in this deque is to be testedtrue
if this deque contains the specified elementpublic boolean isEmpty()
true
if this collection contains no elements.isEmpty
in interface Collection<E>
isEmpty
in class AbstractCollection<E>
true
if this collection contains no elementspublic int size()
Integer.MAX_VALUE
elements, it returns Integer.MAX_VALUE
. Beware that, unlike in most collections, this method is NOT a constant-time operation. Because of the asynchronous nature of these deques, determining the current number of elements requires traversing them all to count them. Additionally, it is possible for the size to change during execution of this method, in which case the returned result will be inaccurate. Thus, this method is typically not very useful in concurrent applications.
public boolean remove(Object o)
e
such that o.equals(e)
(if such an element exists). Returns true
if this deque contained the specified element (or equivalently, if this deque changed as a result of the call). This method is equivalent to removeFirstOccurrence(Object)
.
remove
in interface Collection<E>
remove
in interface Deque<E>
remove
in class AbstractCollection<E>
o
- element to be removed from this deque, if presenttrue
if the deque contained the specified elementNullPointerException
- if the specified element is nullpublic boolean addAll(Collection<? extends E> c)
addAll
of a deque to itself result in IllegalArgumentException
.addAll
in interface Collection<E>
addAll
in interface Deque<E>
addAll
in class AbstractCollection<E>
c
- the elements to be inserted into this dequetrue
if this deque changed as a result of the callNullPointerException
- if the specified collection or any of its elements are nullIllegalArgumentException
- if the collection is this dequepublic void clear()
clear
in interface Collection<E>
clear
in class AbstractCollection<E>
public Object[] toArray()
The returned array will be "safe" in that no references to it are maintained by this deque. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.
This method acts as bridge between array-based and collection-based APIs.
toArray
in interface Collection<E>
toArray
in class AbstractCollection<E>
public <T> T[] toArray(T[] a)
If this deque fits in the specified array with room to spare (i.e., the array has more elements than this deque), the element in the array immediately following the end of the deque is set to null
.
Like the toArray()
method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.
Suppose x
is a deque known to contain only strings. The following code can be used to dump the deque into a newly allocated array of String
:
String[] y = x.toArray(new String[0]);
Note that toArray(new Object[0])
is identical in function to toArray()
.toArray
in interface Collection<E>
toArray
in class AbstractCollection<E>
T
- the component type of the array to contain the collectiona
- the array into which the elements of the deque are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purposeArrayStoreException
- if the runtime type of the specified array is not a supertype of the runtime type of every element in this dequeNullPointerException
- if the specified array is nullpublic Iterator<E> iterator()
The returned iterator is weakly consistent.
public Iterator<E> descendingIterator()
The returned iterator is weakly consistent.
descendingIterator
in interface Deque<E>
public Spliterator<E> spliterator()
Spliterator
over the elements in this deque. The returned spliterator is weakly consistent.
The Spliterator
reports Spliterator.CONCURRENT
, Spliterator.ORDERED
, and Spliterator.NONNULL
.
spliterator
in interface Collection<E>
spliterator
in interface Iterable<E>
Spliterator
implements trySplit
to permit limited parallelism.Spliterator
over the elements in this dequepublic boolean removeIf(Predicate<? super E> filter)
Collection
removeIf
in interface Collection<E>
filter
- a predicate which returns true
for elements to be removedtrue
if any elements were removedNullPointerException
- if the specified filter is nullpublic boolean removeAll(Collection<?> c)
AbstractCollection
removeAll
in interface Collection<E>
removeAll
in class AbstractCollection<E>
c
- collection containing elements to be removed from this collectiontrue
if this collection changed as a result of the callNullPointerException
- if this collection contains one or more null elements and the specified collection does not support null elements (optional) or if the specified collection is nullpublic boolean retainAll(Collection<?> c)
AbstractCollection
retainAll
in interface Collection<E>
retainAll
in class AbstractCollection<E>
c
- collection containing elements to be retained in this collectiontrue
if this collection changed as a result of the callNullPointerException
- if this collection contains one or more null elements and the specified collection does not permit null elements (optional) or if the specified collection is nullpublic void forEach(Consumer<? super E> action)
Iterable
Iterable
until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller. The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified a concurrent modification policy.
forEach
in interface Iterable<E>
action
- The action to be performed for each elementNullPointerException
- if the specified action is null
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/ConcurrentLinkedDeque.html