jdk.util.concurrent.ConcurrentLinkedDeque
An unbounded concurrent java.util.deque based on linked nodes. Concurrent insertion, removal, and access operations execute safely across multiple threads. A 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. Additionally, the bulk operations addAll, removeAll, retainAll, containsAll, equals, and toArray are not guaranteed to be performed atomically. For example, an iterator operating concurrently with an addAll operation might view 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.
An unbounded concurrent java.util.deque based on linked nodes. Concurrent insertion, removal, and access operations execute safely across multiple threads. A 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. Additionally, the bulk operations addAll, removeAll, retainAll, containsAll, equals, and toArray are not guaranteed to be performed atomically. For example, an iterator operating concurrently with an addAll operation might view 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.
->concurrent-linked-dequeclj
(->concurrent-linked-deque)(->concurrent-linked-deque c)Constructor.
Constructs a deque initially containing the elements of the given collection, added in traversal order of the collection's iterator.
c - the collection of elements to initially contain - java.util.Collection
throws: java.lang.NullPointerException - if the specified collection or any of its elements are null
Constructor. Constructs a deque initially containing the elements of the given collection, added in traversal order of the collection's iterator. c - the collection of elements to initially contain - `java.util.Collection` throws: java.lang.NullPointerException - if the specified collection or any of its elements are null
addclj
(add this e)Inserts the specified element at the tail of this deque. As the deque is unbounded, this method will never throw IllegalStateException or return false.
e - element whose presence in this collection is to be ensured - E
returns: true (as specified by Collection.add(E)) - boolean
throws: java.lang.NullPointerException - if the specified element is null
Inserts the specified element at the tail of this deque. As the deque is unbounded, this method will never throw IllegalStateException or return false. e - element whose presence in this collection is to be ensured - `E` returns: true (as specified by Collection.add(E)) - `boolean` throws: java.lang.NullPointerException - if the specified element is null
add-allclj
(add-all this c)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. Attempts to addAll of a deque to itself result in IllegalArgumentException.
c - the elements to be inserted into this deque - java.util.Collection
returns: true if this deque changed as a result of the call - boolean
throws: java.lang.NullPointerException - if the specified collection or any of its elements are null
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. Attempts to addAll of a deque to itself result in IllegalArgumentException. c - the elements to be inserted into this deque - `java.util.Collection` returns: true if this deque changed as a result of the call - `boolean` throws: java.lang.NullPointerException - if the specified collection or any of its elements are null
add-firstclj
(add-first this e)Inserts the specified element at the front of this deque. As the deque is unbounded, this method will never throw IllegalStateException.
e - the element to add - E
throws: java.lang.NullPointerException - if the specified element is null
Inserts the specified element at the front of this deque. As the deque is unbounded, this method will never throw IllegalStateException. e - the element to add - `E` throws: java.lang.NullPointerException - if the specified element is null
add-lastclj
(add-last this e)Inserts the specified element at the end of this deque. As the deque is unbounded, this method will never throw IllegalStateException.
This method is equivalent to add(E).
e - the element to add - E
throws: java.lang.NullPointerException - if the specified element is null
Inserts the specified element at the end of this deque. As the deque is unbounded, this method will never throw IllegalStateException. This method is equivalent to add(E). e - the element to add - `E` throws: java.lang.NullPointerException - if the specified element is null
clearclj
(clear this)Removes all of the elements from this deque.
Removes all of the elements from this deque.
containsclj
(contains this o)Returns true if this deque contains at least one element e such that o.equals(e).
o - element whose presence in this deque is to be tested - java.lang.Object
returns: true if this deque contains the specified element - boolean
Returns true if this deque contains at least one element e such that o.equals(e). o - element whose presence in this deque is to be tested - `java.lang.Object` returns: true if this deque contains the specified element - `boolean`
descending-iteratorclj
(descending-iterator this)Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from last (tail) to first (head).
The returned iterator is weakly consistent.
returns: an iterator over the elements in this deque in reverse order - java.util.Iterator<E>
Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from last (tail) to first (head). The returned iterator is weakly consistent. returns: an iterator over the elements in this deque in reverse order - `java.util.Iterator<E>`
elementclj
(element this)Description copied from interface: Deque
returns: the head of the queue represented by this deque - E
throws: java.util.NoSuchElementException - if this deque is empty
Description copied from interface: Deque returns: the head of the queue represented by this deque - `E` throws: java.util.NoSuchElementException - if this deque is empty
empty?clj
(empty? this)Returns true if this collection contains no elements.
returns: true if this collection contains no elements - boolean
Returns true if this collection contains no elements. returns: true if this collection contains no elements - `boolean`
get-firstclj
(get-first this)Description copied from interface: Deque
returns: the head of this deque - E
throws: java.util.NoSuchElementException - if this deque is empty
Description copied from interface: Deque returns: the head of this deque - `E` throws: java.util.NoSuchElementException - if this deque is empty
get-lastclj
(get-last this)Description copied from interface: Deque
returns: the tail of this deque - E
throws: java.util.NoSuchElementException - if this deque is empty
Description copied from interface: Deque returns: the tail of this deque - `E` throws: java.util.NoSuchElementException - if this deque is empty
iteratorclj
(iterator this)Returns an iterator over the elements in this deque in proper sequence. The elements will be returned in order from first (head) to last (tail).
The returned iterator is weakly consistent.
returns: an iterator over the elements in this deque in proper sequence - java.util.Iterator<E>
Returns an iterator over the elements in this deque in proper sequence. The elements will be returned in order from first (head) to last (tail). The returned iterator is weakly consistent. returns: an iterator over the elements in this deque in proper sequence - `java.util.Iterator<E>`
offerclj
(offer this e)Inserts the specified element at the tail of this deque. As the deque is unbounded, this method will never return false.
e - the element to add - E
returns: true (as specified by Queue.offer(E)) - boolean
throws: java.lang.NullPointerException - if the specified element is null
Inserts the specified element at the tail of this deque. As the deque is unbounded, this method will never return false. e - the element to add - `E` returns: true (as specified by Queue.offer(E)) - `boolean` throws: java.lang.NullPointerException - if the specified element is null
offer-firstclj
(offer-first this e)Inserts the specified element at the front of this deque. As the deque is unbounded, this method will never return false.
e - the element to add - E
returns: true (as specified by Deque.offerFirst(E)) - boolean
throws: java.lang.NullPointerException - if the specified element is null
Inserts the specified element at the front of this deque. As the deque is unbounded, this method will never return false. e - the element to add - `E` returns: true (as specified by Deque.offerFirst(E)) - `boolean` throws: java.lang.NullPointerException - if the specified element is null
offer-lastclj
(offer-last this e)Inserts the specified element at the end of this deque. As the deque is unbounded, this method will never return false.
This method is equivalent to add(E).
e - the element to add - E
returns: true (as specified by Deque.offerLast(E)) - boolean
throws: java.lang.NullPointerException - if the specified element is null
Inserts the specified element at the end of this deque. As the deque is unbounded, this method will never return false. This method is equivalent to add(E). e - the element to add - `E` returns: true (as specified by Deque.offerLast(E)) - `boolean` throws: java.lang.NullPointerException - if the specified element is null
peekclj
(peek this)Description copied from interface: Deque
returns: the head of the queue represented by this deque, or
null if this deque is empty - E
Description copied from interface: Deque
returns: the head of the queue represented by this deque, or
null if this deque is empty - `E`peek-firstclj
(peek-first this)Description copied from interface: Deque
returns: the head of this deque, or null if this deque is empty - E
Description copied from interface: Deque returns: the head of this deque, or null if this deque is empty - `E`
peek-lastclj
(peek-last this)Description copied from interface: Deque
returns: the tail of this deque, or null if this deque is empty - E
Description copied from interface: Deque returns: the tail of this deque, or null if this deque is empty - `E`
pollclj
(poll this)Description copied from interface: Deque
returns: the first element of this deque, or null if
this deque is empty - E
Description copied from interface: Deque
returns: the first element of this deque, or null if
this deque is empty - `E`poll-firstclj
(poll-first this)Description copied from interface: Deque
returns: the head of this deque, or null if this deque is empty - E
Description copied from interface: Deque returns: the head of this deque, or null if this deque is empty - `E`
poll-lastclj
(poll-last this)Description copied from interface: Deque
returns: the tail of this deque, or null if this deque is empty - E
Description copied from interface: Deque returns: the tail of this deque, or null if this deque is empty - `E`
popclj
(pop this)Description copied from interface: Deque
returns: the element at the front of this deque (which is the top
of the stack represented by this deque) - E
throws: java.util.NoSuchElementException - if this deque is empty
Description copied from interface: Deque
returns: the element at the front of this deque (which is the top
of the stack represented by this deque) - `E`
throws: java.util.NoSuchElementException - if this deque is emptypushclj
(push this e)Description copied from interface: Deque
e - the element to push - E
throws: java.lang.NullPointerException - if the specified element is null and this deque does not permit null elements
Description copied from interface: Deque e - the element to push - `E` throws: java.lang.NullPointerException - if the specified element is null and this deque does not permit null elements
removeclj
(remove this)(remove this o)Removes the first element e such that o.equals(e), if such an element exists in this deque. If the deque does not contain the element, it is unchanged.
o - element to be removed from this deque, if present - java.lang.Object
returns: true if the deque contained the specified element - boolean
throws: java.lang.NullPointerException - if the specified element is null
Removes the first element e such that o.equals(e), if such an element exists in this deque. If the deque does not contain the element, it is unchanged. o - element to be removed from this deque, if present - `java.lang.Object` returns: true if the deque contained the specified element - `boolean` throws: java.lang.NullPointerException - if the specified element is null
remove-firstclj
(remove-first this)Description copied from interface: Deque
returns: the head of this deque - E
throws: java.util.NoSuchElementException - if this deque is empty
Description copied from interface: Deque returns: the head of this deque - `E` throws: java.util.NoSuchElementException - if this deque is empty
remove-first-occurrenceclj
(remove-first-occurrence this o)Removes the first element e such that o.equals(e), if such an element exists in this deque. If the deque does not contain the element, it is unchanged.
o - element to be removed from this deque, if present - java.lang.Object
returns: true if the deque contained the specified element - boolean
throws: java.lang.NullPointerException - if the specified element is null
Removes the first element e such that o.equals(e), if such an element exists in this deque. If the deque does not contain the element, it is unchanged. o - element to be removed from this deque, if present - `java.lang.Object` returns: true if the deque contained the specified element - `boolean` throws: java.lang.NullPointerException - if the specified element is null
remove-lastclj
(remove-last this)Description copied from interface: Deque
returns: the tail of this deque - E
throws: java.util.NoSuchElementException - if this deque is empty
Description copied from interface: Deque returns: the tail of this deque - `E` throws: java.util.NoSuchElementException - if this deque is empty
remove-last-occurrenceclj
(remove-last-occurrence this o)Removes the last element e such that o.equals(e), if such an element exists in this deque. If the deque does not contain the element, it is unchanged.
o - element to be removed from this deque, if present - java.lang.Object
returns: true if the deque contained the specified element - boolean
throws: java.lang.NullPointerException - if the specified element is null
Removes the last element e such that o.equals(e), if such an element exists in this deque. If the deque does not contain the element, it is unchanged. o - element to be removed from this deque, if present - `java.lang.Object` returns: true if the deque contained the specified element - `boolean` throws: java.lang.NullPointerException - if the specified element is null
sizeclj
(size this)Returns the number of elements in this deque. If this deque contains more than 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.
returns: the number of elements in this deque - int
Returns the number of elements in this deque. If this deque contains more than 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. returns: the number of elements in this deque - `int`
spliteratorclj
(spliterator this)Returns a Spliterator over the elements in this deque.
The returned spliterator is weakly consistent.
The Spliterator reports Spliterator.CONCURRENT, Spliterator.ORDERED, and Spliterator.NONNULL.
returns: a Spliterator over the elements in this deque - java.util.Spliterator<E>
Returns a Spliterator over the elements in this deque. The returned spliterator is weakly consistent. The Spliterator reports Spliterator.CONCURRENT, Spliterator.ORDERED, and Spliterator.NONNULL. returns: a Spliterator over the elements in this deque - `java.util.Spliterator<E>`
to-arrayclj
(to-array this)(to-array this a)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. If the deque fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this deque.
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().
a - 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 purpose - T[]
returns: an array containing all of the elements in this deque - <T> T[]
throws: java.lang.ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this deque
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. If the deque fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this deque. 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(). a - 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 purpose - `T[]` returns: an array containing all of the elements in this deque - `<T> T[]` throws: java.lang.ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this deque
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close