ConcurrentLinkedQueue (Java Platform SE 6) (original) (raw)

java.util.concurrent

Class ConcurrentLinkedQueue

java.lang.Object java.util.AbstractCollection java.util.AbstractQueue java.util.concurrent.ConcurrentLinkedQueue

Type Parameters:

E - the type of elements held in this collection

All Implemented Interfaces:

Serializable, Iterable, Collection, Queue

public class ConcurrentLinkedQueue

extends AbstractQueue

implements Queue, Serializable

An unbounded thread-safe queue based on linked nodes. This queue orders elements FIFO (first-in-first-out). The head of the queue is that element that has been on the queue the longest time. The tail of the queue is that element that has been on the queue the shortest time. New elements are inserted at the tail of the queue, and the queue retrieval operations obtain elements at the head of the queue. A ConcurrentLinkedQueue is an appropriate choice when many threads will share access to a common collection. This queue does not permit null elements.

This implementation employs an efficient "wait-free" algorithm based on one described in Simple, Fast, and Practical Non-Blocking and Blocking Concurrent Queue Algorithms by Maged M. Michael and Michael L. Scott.

Beware that, unlike in most collections, the size method is NOT a constant-time operation. Because of the asynchronous nature of these queues, determining the current number of elements requires a traversal of the elements.

This class and its iterator implement all of the_optional_ methods of the Collection and Iterator interfaces.

Memory consistency effects: As with other concurrent collections, actions in a thread prior to placing an object into aConcurrentLinkedQueue happen-before actions subsequent to the access or removal of that element from the ConcurrentLinkedQueue in another thread.

This class is a member of the Java Collections Framework.

Since:

1.5

See Also:

Serialized Form

ConcurrentLinkedQueue

public ConcurrentLinkedQueue()

Creates a ConcurrentLinkedQueue that is initially empty.

ConcurrentLinkedQueue

public ConcurrentLinkedQueue(Collection<? extends E> c)

Creates a ConcurrentLinkedQueue initially containing the elements of the given collection, added in traversal order of the collection's iterator.

Parameters:

c - the collection of elements to initially contain

Throws:

[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if the specified collection or any of its elements are null

add

public boolean add(E e)

Inserts the specified element at the tail of this queue.

Specified by:

[add](../../../java/util/Collection.html#add%28E%29) in interface [Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Specified by:

[add](../../../java/util/Queue.html#add%28E%29) in interface [Queue](../../../java/util/Queue.html "interface in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Overrides:

[add](../../../java/util/AbstractQueue.html#add%28E%29) in class [AbstractQueue](../../../java/util/AbstractQueue.html "class in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Parameters:

e - the element to add

Returns:

true (as specified by Collection.add(E))

Throws:

[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if the specified element is null

offer

public boolean offer(E e)

Inserts the specified element at the tail of this queue.

Specified by:

[offer](../../../java/util/Queue.html#offer%28E%29) in interface [Queue](../../../java/util/Queue.html "interface in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Parameters:

e - the element to add

Returns:

true (as specified by Queue.offer(E))

Throws:

[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if the specified element is null

poll

public E poll()

Description copied from interface: [Queue](../../../java/util/Queue.html#poll%28%29)

Retrieves and removes the head of this queue, or returns null if this queue is empty.

Specified by:

[poll](../../../java/util/Queue.html#poll%28%29) in interface [Queue](../../../java/util/Queue.html "interface in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Returns:

the head of this queue, or null if this queue is empty

peek

public E peek()

Description copied from interface: [Queue](../../../java/util/Queue.html#peek%28%29)

Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.

Specified by:

[peek](../../../java/util/Queue.html#peek%28%29) in interface [Queue](../../../java/util/Queue.html "interface in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Returns:

the head of this queue, or null if this queue is empty

isEmpty

public boolean isEmpty()

Returns true if this queue contains no elements.

Specified by:

[isEmpty](../../../java/util/Collection.html#isEmpty%28%29) in interface [Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Overrides:

[isEmpty](../../../java/util/AbstractCollection.html#isEmpty%28%29) in class [AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Returns:

true if this queue contains no elements

size

public int size()

Returns the number of elements in this queue. If this queue contains more than Integer.MAX_VALUE elements, returnsInteger.MAX_VALUE.

Beware that, unlike in most collections, this method is_NOT_ a constant-time operation. Because of the asynchronous nature of these queues, determining the current number of elements requires an O(n) traversal.

Specified by:

[size](../../../java/util/Collection.html#size%28%29) in interface [Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Specified by:

[size](../../../java/util/AbstractCollection.html#size%28%29) in class [AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Returns:

the number of elements in this queue

contains

public boolean contains(Object o)

Returns true if this queue contains the specified element. More formally, returns true if and only if this queue contains at least one element e such that o.equals(e).

Specified by:

[contains](../../../java/util/Collection.html#contains%28java.lang.Object%29) in interface [Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Overrides:

[contains](../../../java/util/AbstractCollection.html#contains%28java.lang.Object%29) in class [AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Parameters:

o - object to be checked for containment in this queue

Returns:

true if this queue contains the specified element

remove

public boolean remove(Object o)

Removes a single instance of the specified element from this queue, if it is present. More formally, removes an element e such that o.equals(e), if this queue contains one or more such elements. Returns true if this queue contained the specified element (or equivalently, if this queue changed as a result of the call).

Specified by:

[remove](../../../java/util/Collection.html#remove%28java.lang.Object%29) in interface [Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Overrides:

[remove](../../../java/util/AbstractCollection.html#remove%28java.lang.Object%29) in class [AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Parameters:

o - element to be removed from this queue, if present

Returns:

true if this queue changed as a result of the call

toArray

public Object[] toArray()

Returns an array containing all of the elements in this queue, in proper sequence.

The returned array will be "safe" in that no references to it are maintained by this queue. (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.

Specified by:

[toArray](../../../java/util/Collection.html#toArray%28%29) in interface [Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Overrides:

[toArray](../../../java/util/AbstractCollection.html#toArray%28%29) in class [AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Returns:

an array containing all of the elements in this queue

toArray

public T[] toArray(T[] a)

Returns an array containing all of the elements in this queue, in proper sequence; the runtime type of the returned array is that of the specified array. If the queue 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 queue.

If this queue fits in the specified array with room to spare (i.e., the array has more elements than this queue), the element in the array immediately following the end of the queue is set tonull.

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 queue known to contain only strings. The following code can be used to dump the queue into a newly allocated array of String:

 String[] y = x.toArray(new String[0]);

Note that toArray(new Object[0]) is identical in function totoArray().

Specified by:

[toArray](../../../java/util/Collection.html#toArray%28T[]%29) in interface [Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Overrides:

[toArray](../../../java/util/AbstractCollection.html#toArray%28T[]%29) in class [AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Parameters:

a - the array into which the elements of the queue are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose

Returns:

an array containing all of the elements in this queue

Throws:

[ArrayStoreException](../../../java/lang/ArrayStoreException.html "class in java.lang") - if the runtime type of the specified array is not a supertype of the runtime type of every element in this queue

[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if the specified array is null

iterator

public Iterator<E> iterator()

Returns an iterator over the elements in this queue in proper sequence. The returned iterator is a "weakly consistent" iterator that will never throw ConcurrentModificationException, and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction.

Specified by:

[iterator](../../../java/lang/Iterable.html#iterator%28%29) in interface [Iterable](../../../java/lang/Iterable.html "interface in java.lang")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Specified by:

[iterator](../../../java/util/Collection.html#iterator%28%29) in interface [Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Specified by:

[iterator](../../../java/util/AbstractCollection.html#iterator%28%29) in class [AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ConcurrentLinkedQueue.html "type parameter in ConcurrentLinkedQueue")>

Returns:

an iterator over the elements in this queue in proper sequence

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.