- Type Parameters:
E- the type of elements held in this queue
- All Implemented Interfaces:
Serializable,Iterable<E>,Collection<E>,BlockingQueue<E>,Queue<E>
The optional capacity bound constructor argument serves as a
way to prevent excessive queue expansion. The capacity, if unspecified,
is equal to Integer.MAX_VALUE. Linked nodes are
dynamically created upon each insertion unless this would bring the
queue above capacity.
This class and its iterator implement all of the optional
methods of the Collection and Iterator interfaces.
This class is a member of the Java Collections Framework.
- Since:
- 1.5
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionCreates aLinkedBlockingQueuewith a capacity ofInteger.MAX_VALUE.LinkedBlockingQueue(int capacity) Creates aLinkedBlockingQueuewith the given (fixed) capacity.LinkedBlockingQueue(Collection<? extends E> c) Creates aLinkedBlockingQueuewith a capacity ofInteger.MAX_VALUE, initially containing the elements of the given collection, added in traversal order of the collection's iterator. -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Atomically removes all of the elements from this queue.booleanReturnstrueif this queue contains the specified element.intdrainTo(Collection<? super E> c) Removes all available elements from this queue and adds them to the given collection.intdrainTo(Collection<? super E> c, int maxElements) Removes at most the given number of available elements from this queue and adds them to the given collection.voidPerforms the given action for each element of theIterableuntil all elements have been processed or the action throws an exception.iterator()Returns an iterator over the elements in this queue in proper sequence.booleanInserts the specified element at the tail of this queue if it is possible to do so immediately without exceeding the queue's capacity, returningtrueupon success andfalseif this queue is full.booleanInserts the specified element at the tail of this queue, waiting if necessary up to the specified wait time for space to become available.peek()Retrieves, but does not remove, the head of this queue, or returnsnullif this queue is empty.poll()Retrieves and removes the head of this queue, or returnsnullif this queue is empty.Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.voidInserts the specified element at the tail of this queue, waiting if necessary for space to become available.intReturns the number of additional elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking.booleanRemoves a single instance of the specified element from this queue, if it is present.booleanremoveAll(Collection<?> c) Removes all of this collection's elements that are also contained in the specified collection (optional operation).booleanRemoves all of the elements of this collection that satisfy the given predicate.booleanretainAll(Collection<?> c) Retains only the elements in this collection that are contained in the specified collection (optional operation).intsize()Returns the number of elements in this queue.Returns aSpliteratorover the elements in this queue.take()Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.Object[]toArray()Returns an array containing all of the elements in this queue, in proper sequence.<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.Methods declared in class java.util.AbstractQueue
add, addAll, element, removeMethods declared in class java.util.AbstractCollection
containsAll, isEmpty, toStringMethods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods declared in interface java.util.concurrent.BlockingQueue
addMethods declared in interface java.util.Collection
addAll, containsAll, equals, hashCode, isEmpty, parallelStream, stream, toArray
-
Constructor Details
-
LinkedBlockingQueue
public LinkedBlockingQueue()Creates aLinkedBlockingQueuewith a capacity ofInteger.MAX_VALUE. -
LinkedBlockingQueue
public LinkedBlockingQueue(int capacity) Creates aLinkedBlockingQueuewith the given (fixed) capacity.- Parameters:
capacity- the capacity of this queue- Throws:
IllegalArgumentException- ifcapacityis not greater than zero
-
LinkedBlockingQueue
Creates aLinkedBlockingQueuewith a capacity ofInteger.MAX_VALUE, 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- if the specified collection or any of its elements are null
-
-
Method Details
-
size
public int size()Returns the number of elements in this queue.- Specified by:
sizein interfaceCollection<E>- Returns:
- the number of elements in this queue
-
remainingCapacity
public int remainingCapacity()Returns the number of additional elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking. This is always equal to the initial capacity of this queue less the currentsizeof this queue.Note that you cannot always tell if an attempt to insert an element will succeed by inspecting
remainingCapacitybecause it may be the case that another thread is about to insert or remove an element.- Specified by:
remainingCapacityin interfaceBlockingQueue<E>- Returns:
- the remaining capacity
-
put
Inserts the specified element at the tail of this queue, waiting if necessary for space to become available.- Specified by:
putin interfaceBlockingQueue<E>- Parameters:
e- the element to add- Throws:
InterruptedException- if interrupted while waitingNullPointerException- if the specified element is null
-
offer
Inserts the specified element at the tail of this queue, waiting if necessary up to the specified wait time for space to become available.- Specified by:
offerin interfaceBlockingQueue<E>- Parameters:
e- the element to addtimeout- how long to wait before giving up, in units ofunitunit- aTimeUnitdetermining how to interpret thetimeoutparameter- Returns:
trueif successful, orfalseif the specified waiting time elapses before space is available- Throws:
InterruptedException- if interrupted while waitingNullPointerException- if the specified element is null
-
offer
Inserts the specified element at the tail of this queue if it is possible to do so immediately without exceeding the queue's capacity, returningtrueupon success andfalseif this queue is full. When using a capacity-restricted queue, this method is generally preferable to methodadd, which can fail to insert an element only by throwing an exception.- Specified by:
offerin interfaceBlockingQueue<E>- Specified by:
offerin interfaceQueue<E>- Parameters:
e- the element to add- Returns:
trueif the element was added to this queue, elsefalse- Throws:
NullPointerException- if the specified element is null
-
take
Description copied from interface:BlockingQueueRetrieves and removes the head of this queue, waiting if necessary until an element becomes available.- Specified by:
takein interfaceBlockingQueue<E>- Returns:
- the head of this queue
- Throws:
InterruptedException- if interrupted while waiting
-
poll
Description copied from interface:BlockingQueueRetrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.- Specified by:
pollin interfaceBlockingQueue<E>- Parameters:
timeout- how long to wait before giving up, in units ofunitunit- aTimeUnitdetermining how to interpret thetimeoutparameter- Returns:
- the head of this queue, or
nullif the specified waiting time elapses before an element is available - Throws:
InterruptedException- if interrupted while waiting
-
poll
Description copied from interface:QueueRetrieves and removes the head of this queue, or returnsnullif this queue is empty. -
peek
Description copied from interface:QueueRetrieves, but does not remove, the head of this queue, or returnsnullif this queue is empty. -
remove
Removes a single instance of the specified element from this queue, if it is present. More formally, removes an elementesuch thato.equals(e), if this queue contains one or more such elements. Returnstrueif this queue contained the specified element (or equivalently, if this queue changed as a result of the call).- Specified by:
removein interfaceBlockingQueue<E>- Specified by:
removein interfaceCollection<E>- Overrides:
removein classAbstractCollection<E>- Parameters:
o- element to be removed from this queue, if present- Returns:
trueif this queue changed as a result of the call
-
contains
Returnstrueif this queue contains the specified element. More formally, returnstrueif and only if this queue contains at least one elementesuch thato.equals(e).- Specified by:
containsin interfaceBlockingQueue<E>- Specified by:
containsin interfaceCollection<E>- Overrides:
containsin classAbstractCollection<E>- Parameters:
o- object to be checked for containment in this queue- Returns:
trueif this queue contains the specified element
-
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:
toArrayin interfaceCollection<E>- Overrides:
toArrayin classAbstractCollection<E>- Returns:
- an array containing all of the elements in this queue
-
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
xis a queue known to contain only strings. The following code can be used to dump the queue into a newly allocated array ofString:
Note thatString[] y = x.toArray(new String[0]);toArray(new Object[0])is identical in function totoArray().- Specified by:
toArrayin interfaceCollection<E>- Overrides:
toArrayin classAbstractCollection<E>- Type Parameters:
T- the component type of the array to contain the collection- 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- if the runtime type of the specified array is not a supertype of the runtime type of every element in this queueNullPointerException- if the specified array is null
-
clear
public void clear()Atomically removes all of the elements from this queue. The queue will be empty after this call returns.- Specified by:
clearin interfaceCollection<E>- Overrides:
clearin classAbstractQueue<E>
-
drainTo
Description copied from interface:BlockingQueueRemoves all available elements from this queue and adds them to the given collection. This operation may be more efficient than repeatedly polling this queue. A failure encountered while attempting to add elements to collectioncmay result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result inIllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.- Specified by:
drainToin interfaceBlockingQueue<E>- Parameters:
c- the collection to transfer elements into- Returns:
- the number of elements transferred
- Throws:
UnsupportedOperationException- if addition of elements is not supported by the specified collectionClassCastException- if the class of an element of this queue prevents it from being added to the specified collectionNullPointerException- if the specified collection is nullIllegalArgumentException- if the specified collection is this queue, or some property of an element of this queue prevents it from being added to the specified collection
-
drainTo
Description copied from interface:BlockingQueueRemoves at most the given number of available elements from this queue and adds them to the given collection. A failure encountered while attempting to add elements to collectioncmay result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result inIllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.- Specified by:
drainToin interfaceBlockingQueue<E>- Parameters:
c- the collection to transfer elements intomaxElements- the maximum number of elements to transfer- Returns:
- the number of elements transferred
- Throws:
UnsupportedOperationException- if addition of elements is not supported by the specified collectionClassCastException- if the class of an element of this queue prevents it from being added to the specified collectionNullPointerException- if the specified collection is nullIllegalArgumentException- if the specified collection is this queue, or some property of an element of this queue prevents it from being added to the specified collection
-
iterator
Returns an iterator over the elements in this queue in proper sequence. The elements will be returned in order from first (head) to last (tail).The returned iterator is weakly consistent.
- Specified by:
iteratorin interfaceCollection<E>- Specified by:
iteratorin interfaceIterable<E>- Specified by:
iteratorin classAbstractCollection<E>- Returns:
- an iterator over the elements in this queue in proper sequence
-
spliterator
Returns aSpliteratorover the elements in this queue.The returned spliterator is weakly consistent.
The
SpliteratorreportsSpliterator.CONCURRENT,Spliterator.ORDERED, andSpliterator.NONNULL.- Specified by:
spliteratorin interfaceCollection<E>- Specified by:
spliteratorin interfaceIterable<E>- Implementation Note:
- The
SpliteratorimplementstrySplitto permit limited parallelism. - Returns:
- a
Spliteratorover the elements in this queue - Since:
- 1.8
-
forEach
Description copied from interface:IterablePerforms the given action for each element of theIterableuntil 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.
- Specified by:
forEachin interfaceIterable<E>- Parameters:
action- The action to be performed for each element- Throws:
NullPointerException- if the specified action is null
-
removeIf
Description copied from interface:CollectionRemoves all of the elements of this collection that satisfy the given predicate. Errors or runtime exceptions thrown during iteration or by the predicate are relayed to the caller.- Specified by:
removeIfin interfaceCollection<E>- Parameters:
filter- a predicate which returnstruefor elements to be removed- Returns:
trueif any elements were removed- Throws:
NullPointerException- if the specified filter is null
-
removeAll
Description copied from class:AbstractCollectionRemoves all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.- Specified by:
removeAllin interfaceCollection<E>- Overrides:
removeAllin classAbstractCollection<E>- Parameters:
c- collection containing elements to be removed from this collection- Returns:
trueif this collection changed as a result of the call- Throws:
NullPointerException- 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 null- See Also:
-
retainAll
Description copied from class:AbstractCollectionRetains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.- Specified by:
retainAllin interfaceCollection<E>- Overrides:
retainAllin classAbstractCollection<E>- Parameters:
c- collection containing elements to be retained in this collection- Returns:
trueif this collection changed as a result of the call- Throws:
NullPointerException- 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 null- See Also:
-