java.util.concurrent
Class ConcurrentLinkedQueue

public class ConcurrentLinkedQueue<E>
extends AbstractQueue<E>
implements Serializable, Queue<E>
Type Parameters:
  • E - the type of elements held in this collection
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 a ConcurrentLinkedQueue 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.

Since1.5
VersionNot specified.
AuthorDoug Lea
Wiki javadoc Use textile entry format.
Add your comments here.
Constructor Summary
ConcurrentLinkedQueue()
Creates a ConcurrentLinkedQueue that is initially empty.
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.
Method Summary
boolean add( E e )
Inserts the specified element at the tail of this queue.
boolean contains( Object o )
Returns true if this queue contains the specified element.
boolean isEmpty()
Returns true if this queue contains no elements.
Iterator<E> iterator()
Returns an iterator over the elements in this queue in proper sequence.
boolean offer( E e )
Inserts the specified element at the tail of this queue.
E peek()
No description provided.
E poll()
No description provided.
boolean remove( Object o )
Removes a single instance of the specified element from this queue, if it is present.
int size()
Returns the number of elements in this queue.
Object[] toArray()
Returns an array containing all of the elements in this queue, in proper sequence.
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.
Methods inherited from java.utilQueue
ConcurrentLinkedQueue
public ConcurrentLinkedQueue ( )
Creates a ConcurrentLinkedQueue that is initially empty.
Wiki javadoc Use textile entry format.
Add your comments here.
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
TypeNameDescription
Collection<? extends E> c the collection of elements to initially contain
Wiki javadoc Use textile entry format.
Add your comments here.
add
public boolean add ( E e )
Inserts the specified element at the tail of this queue.
Overrides method in AbstractQueue
Parameters
TypeNameDescription
E e No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
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).
Overrides method in AbstractCollection
Parameters
TypeNameDescription
Object o object to be checked for containment in this queue
Wiki javadoc Use textile entry format.
Add your comments here.
isEmpty
public boolean isEmpty ( )
Returns true if this queue contains no elements.
Overrides method in AbstractCollection
Wiki javadoc Use textile entry format.
Add your comments here.
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.
Overrides method in AbstractCollection
Wiki javadoc Use textile entry format.
Add your comments here.
offer
public boolean offer ( E e )
Inserts the specified element at the tail of this queue.
Implements method in Queue
Parameters
TypeNameDescription
E e No description provided.
Wiki javadoc Use textile entry format.
Add your comments here.
peek
public E peek ( )
No description provided.
Implements method in Queue
Wiki javadoc Use textile entry format.
Add your comments here.
poll
public E poll ( )
No description provided.
Implements method in Queue
Wiki javadoc Use textile entry format.
Add your comments here.
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).
Overrides method in AbstractCollection
Parameters
TypeNameDescription
Object o element to be removed from this queue, if present
Wiki javadoc Use textile entry format.
Add your comments here.
size
public int size ( )
Returns the number of elements in this queue. If this queue contains more than Integer.MAX_VALUE elements, 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 queues, determining the current number of elements requires an O(n) traversal.

Overrides method in AbstractCollection
Wiki javadoc Use textile entry format.
Add your comments here.
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.

Overrides method in AbstractCollection
Wiki javadoc Use textile entry format.
Add your comments here.
toArray
public <T> 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 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 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 to toArray().
Overrides method in AbstractCollection
Parameters
TypeNameDescription
T[] 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
Wiki javadoc Use textile entry format.
Add your comments here.