E - the type of elements held in this queueSerializable, Iterable<E>, Collection<E>, BlockingQueue<E>, Queue<E>
public class LinkedBlockingQueue<E> extends AbstractQueue<E> implements BlockingQueue<E>, Serializable
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.
| Constructor | Description |
|---|---|
LinkedBlockingQueue() |
Creates a LinkedBlockingQueue with a capacity of Integer.MAX_VALUE. |
LinkedBlockingQueue |
Creates a LinkedBlockingQueue with the given (fixed) capacity. |
LinkedBlockingQueue |
Creates a LinkedBlockingQueue with a capacity of Integer.MAX_VALUE, initially containing the elements of the given collection, added in traversal order of the collection's iterator. |
| Modifier and Type | Method | Description |
|---|---|---|
void |
clear() |
Atomically removes all of the elements from this queue. |
boolean |
contains |
Returns true if this queue contains the specified element. |
int |
drainTo |
Removes all available elements from this queue and adds them to the given collection. |
int |
drainTo |
Removes at most the given number of available elements from this queue and adds them to the given collection. |
void |
forEach |
Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception. |
Iterator |
iterator() |
Returns an iterator over the elements in this queue in proper sequence. |
boolean |
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, returning true upon success and false if this queue is full. |
boolean |
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. |
E |
peek() |
Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty. |
E |
poll() |
Retrieves and removes the head of this queue, or returns null if this queue is empty. |
E |
poll |
Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available. |
void |
put |
Inserts the specified element at the tail of this queue, waiting if necessary for space to become available. |
int |
remainingCapacity() |
Returns the number of additional elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking. |
boolean |
remove |
Removes a single instance of the specified element from this queue, if it is present. |
boolean |
removeAll |
Removes all of this collection's elements that are also contained in the specified collection (optional operation). |
boolean |
removeIf |
Removes all of the elements of this collection that satisfy the given predicate. |
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 queue. |
Spliterator |
spliterator() |
Returns a Spliterator over the elements in this queue. |
E |
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 |
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. |
add, addAll, element, remove
containsAll, isEmpty, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
add
addAll, containsAll, equals, hashCode, isEmpty, parallelStream, stream, toArray
public LinkedBlockingQueue()
LinkedBlockingQueue with a capacity of Integer.MAX_VALUE.public LinkedBlockingQueue(int capacity)
LinkedBlockingQueue with the given (fixed) capacity.capacity - the capacity of this queueIllegalArgumentException - if capacity is not greater than zeropublic LinkedBlockingQueue(Collection<? extends E> c)
LinkedBlockingQueue with a capacity of Integer.MAX_VALUE, initially containing the elements of the given collection, added in traversal order of the collection's iterator.c - the collection of elements to initially containNullPointerException - if the specified collection or any of its elements are nullpublic int size()
size in interface Collection<E>
public int remainingCapacity()
size of this queue. Note that you cannot always tell if an attempt to insert an element will succeed by inspecting remainingCapacity because it may be the case that another thread is about to insert or remove an element.
remainingCapacity in interface BlockingQueue<E>
public void put(E e) throws InterruptedException
put in interface BlockingQueue<E>
e - the element to addInterruptedException - if interrupted while waitingNullPointerException - if the specified element is nullpublic boolean offer(E e, long timeout, TimeUnit unit) throws InterruptedException
offer in interface BlockingQueue<E>
e - the element to addtimeout - how long to wait before giving up, in units of unit
unit - a TimeUnit determining how to interpret the timeout parametertrue if successful, or false if the specified waiting time elapses before space is availableInterruptedException - if interrupted while waitingNullPointerException - if the specified element is nullpublic boolean offer(E e)
true upon success and false if this queue is full. When using a capacity-restricted queue, this method is generally preferable to method add, which can fail to insert an element only by throwing an exception.offer in interface BlockingQueue<E>
offer in interface Queue<E>
e - the element to addtrue if the element was added to this queue, else false
NullPointerException - if the specified element is nullpublic E take() throws InterruptedException
BlockingQueuetake in interface BlockingQueue<E>
InterruptedException - if interrupted while waitingpublic E poll(long timeout, TimeUnit unit) throws InterruptedException
BlockingQueuepoll in interface BlockingQueue<E>
timeout - how long to wait before giving up, in units of unit
unit - a TimeUnit determining how to interpret the timeout parameternull if the specified waiting time elapses before an element is availableInterruptedException - if interrupted while waitingpublic E poll()
Queuenull if this queue is empty.public E peek()
Queuenull if this queue is empty.public boolean remove(Object o)
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).remove in interface BlockingQueue<E>
remove in interface Collection<E>
remove in class AbstractCollection<E>
o - element to be removed from this queue, if presenttrue if this queue changed as a result of the callpublic boolean contains(Object o)
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).contains in interface BlockingQueue<E>
contains in interface Collection<E>
contains in class AbstractCollection<E>
o - object to be checked for containment in this queuetrue if this queue contains the specified elementpublic Object[] toArray()
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.
toArray in interface Collection<E>
toArray in class AbstractCollection<E>
public <T> T[] toArray(T[] a)
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().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 queue 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 queueNullPointerException - if the specified array is nullpublic void clear()
clear in interface Collection<E>
clear in class AbstractQueue<E>
public int drainTo(Collection<? super E> c)
BlockingQueuec may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.drainTo in interface BlockingQueue<E>
c - the collection to transfer elements intoUnsupportedOperationException - 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 collectionpublic int drainTo(Collection<? super E> c, int maxElements)
BlockingQueuec may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.drainTo in interface BlockingQueue<E>
c - the collection to transfer elements intomaxElements - the maximum number of elements to transferUnsupportedOperationException - 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 collectionpublic Iterator<E> iterator()
The returned iterator is weakly consistent.
iterator in interface Collection<E>
iterator in interface Iterable<E>
iterator in class AbstractCollection<E>
public Spliterator<E> spliterator()
Spliterator over the elements in this queue. 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 queuepublic void forEach(Consumer<? super E> action)
IterableIterable 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 nullpublic boolean removeIf(Predicate<? super E> filter)
CollectionremoveIf 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)
AbstractCollectionremoveAll 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)
AbstractCollectionretainAll 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 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/LinkedBlockingQueue.html