Класс LinkedBlockingQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

java.util.concurrent.LinkedBlockingQueue<E>

Type Parameters:: E - тип элементов, хранящихся в этой очереди

Все реализуемые интерфейсы:: Serializable, Iterable<E>, Collection<E>, BlockingQueue<E>, Queue<E>

public class LinkedBlockingQueue<E> extends AbstractQueue<E> implements BlockingQueue<E>, Serializable

Необязательно ограниченная блокирующая очередь на основе связанных узлов. Эта очередь упорядочивает элементы FIFO (первым вошел, первым вышел). Голова очереди — это элемент, который находится в очереди дольше всего. Хвост очереди — это элемент, который находится в очереди кратчайшее время. Новые элементы вставляются в хвост очереди, а операции извлечения из очереди получают элементы из головы очереди. Очереди на основе связанных узлов обычно имеют более высокую производительность, чем очереди на основе массивов, но менее предсказуемую производительность в большинстве конкурирующих приложений.

Необязательный параметр ограниченной вместимости конструктора служит способом предотвращения чрезмерного расширения очереди. Вместимость, если она не указана, равна Integer.MAX_VALUE. Связанные узлы динамически создаются при каждой вставке, если это не приведет к превышению вместимости очереди.

Этот класс и его итератор реализуют все необязательные методы интерфейсов Collection и Iterator.

Этот класс является членом Java Collections Framework.

Since:

1.5

См. также:

Сериализованная форма

Краткое описание конструкторов

Конструктор	Описание
`LinkedBlockingQueue()`	Создает `LinkedBlockingQueue` с вместимостью `Integer.MAX_VALUE`.
`LinkedBlockingQueue(int capacity)`	Создает `LinkedBlockingQueue` с заданной (фиксированной) вместимостью.
`LinkedBlockingQueue(Collection<? extends E> c)`	Создает `LinkedBlockingQueue` с вместимостью `Integer.MAX_VALUE`, изначально содержащую элементы заданного набора, добавленные в порядке обхода итератора набора.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`clear()`	Атомарно удаляет все элементы из этой очереди.
`boolean`	`contains(Object o)`	Возвращает `true`, если эта очередь содержит указанный элемент.
`int`	`drainTo(Collection<? super E> c)`	Удаляет все доступные элементы из этой очереди и добавляет их в заданный набор.
`int`	`drainTo(Collection<? super E> c, int maxElements)`	Удаляет не более заданного количества доступных элементов из этой очереди и добавляет их в заданный набор.
`void`	`forEach(Consumer<? super E> action)`	Выполняет заданное действие для каждого элемента `Iterable`, пока все элементы не будут обработаны или действие не выбросит исключение.
`Iterator<E>`	`iterator()`	Возвращает итератор по элементам в этой очереди в правильной последовательности.
`boolean`	`offer(E e)`	Вставляет указанный элемент в хвост этой очереди, если это возможно сделать немедленно, не превысив вместимость очереди, возвращает `true` при успехе и `false` если эта очередь заполнена.
`boolean`	`offer(E e, long timeout, TimeUnit unit)`	Вставляет указанный элемент в хвост этой очереди, ожидая, если необходимо, в течение указанного времени ожидания, пока освободится место.
`E`	`peek()`	Извлекает, но не удаляет, голову этой очереди или возвращает `null` если эта очередь пуста.
`E`	`poll()`	Извлекает и удаляет голову этой очереди или возвращает `null` если эта очередь пуста.
`E`	`poll(long timeout, TimeUnit unit)`	Извлекает и удаляет голову этой очереди, ожидая в случае необходимости до указанного времени ожидания, пока элемент не станет доступным.
`void`	`put(E e)`	Вставляет указанный элемент в хвост этой очереди, ожидая, если необходимо, пока освободится место.
`int`	`remainingCapacity()`	Возвращает количество дополнительных элементов, которые эта очередь может в идеале (в отсутствие ограничений памяти или ресурсов) принять без блокировки.
`boolean`	`remove(Object o)`	Удаляет один экземпляр указанного элемента из этой очереди, если он присутствует.
`boolean`	`removeAll(Collection<?> c)`	Удаляет все элементы этого набора, которые также содержатся в заданном наборе (необязательная операция).
`boolean`	`removeIf(Predicate<? super E> filter)`	Удаляет все элементы этого набора, которые удовлетворяют заданному предикату.
`boolean`	`retainAll(Collection<?> c)`	Сохраняет только элементы в этом наборе, которые содержатся в заданном наборе (необязательная операция).
`int`	`size()`	Возвращает количество элементов в этой очереди.
`Spliterator<E>`	`spliterator()`	Возвращает `Spliterator` по элементам в этой очереди.
`E`	`take()`	Извлекает и удаляет голову этой очереди, ожидая, если необходимо, до тех пор, пока элемент не станет доступным.
`Object[]`	`toArray()`	Возвращает массив, содержащий все элементы в этой очереди в правильной последовательности.
`<T> T[]`	`toArray(T[] a)`	Возвращает массив, содержащий все элементы в этой очереди в правильной последовательности; тип возвращаемого массива — тип указанного массива.

Методы, объявленные в классе java.util.AbstractQueue

add, addAll, element, remove

Методы, объявленные в классе java.util.AbstractCollection

containsAll, isEmpty, toString

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Методы, объявленные в интерфейсе java.util.concurrent.BlockingQueue

add

Методы, объявленные в интерфейсе java.util.Collection

addAll, containsAll, equals, hashCode, isEmpty, parallelStream, stream, toArray

Методы, объявленные в интерфейсе java.util.Queue

element, remove

Подробное описание конструкторов

LinkedBlockingQueue

public LinkedBlockingQueue()

Создаёт LinkedBlockingQueue с ёмкостью Integer.MAX_VALUE.

LinkedBlockingQueue

public LinkedBlockingQueue(int capacity)

Создаёт LinkedBlockingQueue с заданной (фиксированной) ёмкостью.

Параметры:: capacity - ёмкость этой очереди
Исключения:: IllegalArgumentException - если capacity не больше нуля

LinkedBlockingQueue

public LinkedBlockingQueue(Collection<? extends E> c)

Создаёт LinkedBlockingQueue с ёмкостью Integer.MAX_VALUE, которая изначально содержит элементы заданного набора, добавленные в порядке обхода итератора набора.

Параметры:: c - набор элементов, которые изначально должны содержаться
Исключения:: NullPointerException - если указанный набор или любой из его элементов равны null

Подробное описание методов

size

public int size()

Возвращает количество элементов в этой очереди.

Определено в:: size в интерфейсе Collection<E>
Возвращает:: количество элементов в этой очереди

remainingCapacity

public int remainingCapacity()

Возвращает количество дополнительных элементов, которые эта очередь может теоретически (в отсутствие ограничений памяти или ресурсов) принять без блокировки. Это всегда равно начальной ёмкости этой очереди минус текущее size этой очереди.

Обратите внимание, что вы не всегда можете определить, будет ли попытка вставить элемент успешной, посмотрев на remainingCapacity, так как может быть случай, когда другой поток в данный момент вставляет или удаляет элемент.

Определено в:: remainingCapacity в интерфейсе BlockingQueue<E>
Возвращает:: оставшуюся ёмкость

put

public void put(E e) throws InterruptedException

Вставляет указанный элемент в конец этой очереди, ожидая, если необходимо, пока освободится место.

Определено в:: put в интерфейсе BlockingQueue<E>
Параметры:: e - элемент для добавления
Исключения:: InterruptedException - если прервано ожидание; NullPointerException - если указанный элемент равен null

offer

public boolean offer(E e, long timeout, TimeUnit unit) throws InterruptedException

Вставляет указанный элемент в конец этой очереди, ожидая, если необходимо, в течение заданного времени, пока освободится место.

Определено в:: offer в интерфейсе BlockingQueue<E>
Параметры:: e - элемент для добавления; timeout - время ожидания, прежде чем отказаться, в единицах unit; unit - объект TimeUnit, определяющий, как интерпретировать параметр timeout
Возвращает:: true если успешно, или false если заданное время ожидания истекло, прежде чем освободилось место
Исключения:: InterruptedException - если прервано ожидание; NullPointerException - если указанный элемент равен null

offer

public boolean offer(E e)

Вставляет указанный элемент в конец этой очереди, если это возможно сделать немедленно, не превышая ёмкость очереди, возвращая true при успехе и false если эта очередь полна. При использовании очереди с ограниченной ёмкостью этот метод, как правило, предпочтительнее метода add, который может не вставить элемент, только если бросить исключение.

Определено в:: offer в интерфейсе BlockingQueue<E>
Определено в:: offer в интерфейсе Queue<E>
Параметры:: e - элемент для добавления
Возвращает:: true если элемент был добавлен в эту очередь, в противном случае false
Исключения:: NullPointerException - если указанный элемент равен null

take

public E take() throws InterruptedException

Описание скопировано из интерфейса: BlockingQueue

Извлекает и удаляет голову этой очереди, ожидая, если необходимо, пока появится элемент.

Определено в:: take в интерфейсе BlockingQueue<E>
Возвращает:: голову этой очереди
Исключения:: InterruptedException - если прервано ожидание

poll

public E poll(long timeout, TimeUnit unit) throws InterruptedException

Описание скопировано из интерфейса: BlockingQueue

Извлекает и удаляет голову этой очереди, ожидая в течение заданного времени, если необходимо, пока появится элемент.

Определено в:: poll в интерфейсе BlockingQueue<E>
Параметры:: timeout - время ожидания, прежде чем отказаться, в единицах unit; unit - объект TimeUnit, определяющий, как интерпретировать параметр timeout
Возвращает:: голову этой очереди или null если заданное время ожидания истекло, прежде чем появился элемент
Исключения:: InterruptedException - если прервано ожидание

poll

public E poll()

Описание скопировано из интерфейса: Queue

Извлекает и удаляет голову этой очереди или возвращает null если эта очередь пуста.

Определено в:: poll в интерфейсе Queue<E>
Возвращает:: голову этой очереди или null если эта очередь пуста

peek

public E peek()

Описание скопировано из интерфейса: Queue

Извлекает, но не удаляет, голову этой очереди или возвращает null если эта очередь пуста.

Определено в:: peek в интерфейсе Queue<E>
Возвращает:: голову этой очереди или null если эта очередь пуста

remove

public boolean remove(Object o)

Удаляет единственный экземпляр указанного элемента из этой очереди, если он присутствует. Более формально, удаляет элемент e, такой, что o.equals(e), если эта очередь содержит один или несколько таких элементов. Возвращает true если эта очередь содержала указанный элемент (или эквивалентно, если эта очередь изменилась в результате вызова).

Определено в:: remove в интерфейсе BlockingQueue<E>
Определено в:: remove в интерфейсе Collection<E>
Переопределяет:: remove в классе AbstractCollection<E>
Параметры:: o - элемент, который нужно удалить из этой очереди, если он присутствует
Возвращает:: true если эта очередь изменилась в результате вызова

contains

public boolean contains(Object o)

Возвращает true если эта очередь содержит указанный элемент. Более формально, возвращает true тогда и только тогда, когда эта очередь содержит как минимум один элемент e, такой, что o.equals(e).

Определено в:: contains в интерфейсе BlockingQueue<E>
Определено в:: contains в интерфейсе Collection<E>
Переопределяет:: contains в классе AbstractCollection<E>
Параметры:: o - объект, который нужно проверить на наличие в этой очереди
Возвращает:: true если эта очередь содержит указанный элемент

toArray

public Object[] toArray()

Возвращает массив, содержащий все элементы этой очереди в правильном порядке.

Возвращаемый массив будет "безопасным" в том смысле, что к нему не сохраняются ссылки из этой очереди. (Другими словами, этот метод должен выделять новый массив). Таким образом, вызывающая сторона свободна изменять возвращаемый массив.

Этот метод служит мостом между API на основе массивов и API на основе коллекций.

Определено в:: toArray в интерфейсе Collection<E>
Переопределяет:: toArray в классе AbstractCollection<E>
Возвращает:: массив, содержащий все элементы этой очереди

toArray

public <T> T[] toArray(T[] a)

Возвращает массив, содержащий все элементы этой очереди в правильной последовательности; тип возвращаемого массива — тип указанного массива. Если очередь помещается в указанный массив, она возвращается в нём. В противном случае выделяется новый массив с типом указанного массива и размером этой очереди.

Если эта очередь помещается в указанный массив с избытком места (т. е. массив имеет больше элементов, чем эта очередь), элемент в массиве непосредственно после конца очереди устанавливается в null.

Как и метод toArray(), этот метод служит мостом между массивоориентированными и коллекционноориентированными API. Кроме того, этот метод позволяет точно управлять типом возвращаемого массива и в некоторых случаях может использоваться для экономии расходов на выделение памяти.

Предположим, что x — это очередь, известно, что она содержит только строки. Следующий код может быть использован для выгрузки очереди в новый выделенный массив String:

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

Обратите внимание, что toArray(new Object[0]) идентичен по функции toArray().

Specified by:: toArray в интерфейсе Collection<E>
Overrides:: toArray в классе AbstractCollection<E>
Type Parameters:: T - тип компонента массива, содержащего коллекцию
Parameters:: a - массив, в который должны быть помещены элементы очереди, если он достаточно большой; в противном случае для этой цели выделяется новый массив того же типа
Returns:: массив, содержащий все элементы этой очереди
Throws:: ArrayStoreException - если тип runtime указанного массива не является супертипом типа runtime каждого элемента в этой очереди; NullPointerException - если указанный массив null

clear

public void clear()

Атомарно удаляет все элементы из этой очереди. Очередь будет пустой после возврата этого вызова.

Specified by:: clear в интерфейсе Collection<E>
Overrides:: clear в классе AbstractQueue<E>

drainTo

public int drainTo(Collection<? super E> c)

Описание скопировано из интерфейса: BlockingQueue

Удаляет все доступные элементы из этой очереди и добавляет их в заданную коллекцию. Эта операция может быть более эффективной, чем многократное опроса этой очереди. Ошибка, возникшая при попытке добавить элементы в коллекцию c, может привести к тому, что элементы будут находиться ни в одной, ни в той, ни в другой, ни в обеих коллекциях, когда будет выброшено связанное исключение. Попытки слить очередь в себя приводят к IllegalArgumentException. Кроме того, поведение этой операции не определено, если указанная коллекция изменяется во время выполнения операции.

Specified by:: drainTo в интерфейсе BlockingQueue<E>
Parameters:: c - коллекция, в которую нужно перенести элементы
Returns:: количество перенесённых элементов
Throws:: UnsupportedOperationException - если добавление элементов не поддерживается заданной коллекцией; ClassCastException - если класс элемента этой очереди не позволяет добавить его в указанную коллекцию; NullPointerException - если указанная коллекция null; IllegalArgumentException - если указанная коллекция — это эта очередь, или какое-либо свойство элемента этой очереди мешает добавлению в указанную коллекцию

drainTo

public int drainTo(Collection<? super E> c, int maxElements)

Описание скопировано из интерфейса: BlockingQueue

Удаляет не более заданного количества доступных элементов из этой очереди и добавляет их в заданную коллекцию. Ошибка, возникшая при попытке добавить элементы в коллекцию c, может привести к тому, что элементы будут находиться ни в одной, ни в той, ни в другой, ни в обеих коллекциях, когда будет выброшено связанное исключение. Попытки слить очередь в себя приводят к IllegalArgumentException. Кроме того, поведение этой операции не определено, если указанная коллекция изменяется во время выполнения операции.

Specified by:: drainTo в интерфейсе BlockingQueue<E>
Parameters:: c - коллекция, в которую нужно перенести элементы; maxElements - максимальное количество элементов для переноса
Returns:: количество перенесённых элементов
Throws:: UnsupportedOperationException - если добавление элементов не поддерживается заданной коллекцией; ClassCastException - если класс элемента этой очереди не позволяет добавить его в указанную коллекцию; NullPointerException - если указанная коллекция null; IllegalArgumentException - если указанная коллекция — это эта очередь, или какое-либо свойство элемента этой очереди мешает добавлению в указанную коллекцию

iterator

public Iterator<E> iterator()

Возвращает итератор по элементам в этой очереди в правильной последовательности. Элементы будут возвращаться в порядке от первого (головки) к последнему (хвосту).

Возвращаемый итератор слабо согласован.

Specified by:: iterator в интерфейсе Collection<E>
Specified by:: iterator в интерфейсе Iterable<E>
Specified by:: iterator в классе AbstractCollection<E>
Returns:: итератор по элементам в этой очереди в правильной последовательности

spliterator

public Spliterator<E> spliterator()

Возвращает Spliterator по элементам в этой очереди.

Возвращаемый разделитель слабо согласован.

Разделитель Spliterator сообщает о Spliterator.CONCURRENT, Spliterator.ORDERED и Spliterator.NONNULL.

Specified by:: spliterator в интерфейсе Collection<E>
Specified by:: spliterator в интерфейсе Iterable<E>
Implementation Note:: Spliterator реализует trySplit для поддержки ограниченного параллелизма.
Returns:: Spliterator по элементам в этой очереди
Since:: 1.8

forEach

public void forEach(Consumer<? super E> action)

Описание скопировано из интерфейса: Iterable

Выполняет заданное действие для каждого элемента Iterable до тех пор, пока все элементы не будут обработаны или действие не выбросит исключение. Действия выполняются в порядке итерации, если этот порядок указан. Исключение, выброшенное действием, передаётся вызывающему методу.

Поведение этого метода не определено, если действие производит побочные эффекты, которые изменяют базовый источник элементов, если только переопределяемый класс не указал политику одновременного изменения.

Specified by:: forEach в интерфейсе Iterable<E>
Parameters:: action - действие, которое должно выполняться для каждого элемента
Throws:: NullPointerException - если заданное действие null

removeIf

public boolean removeIf(Predicate<? super E> filter)

Описание скопировано из интерфейса: Collection

Удаляет все элементы этой коллекции, которые удовлетворяют заданному предикату. Ошибки или исключения времени выполнения, выброшенные во время итерации или предикатом, передаются вызывающему методу.

Specified by:: removeIf в интерфейсе Collection<E>
Parameters:: filter - предикат, возвращающий true для удаляемых элементов
Returns:: true если какие-либо элементы были удалены
Throws:: NullPointerException - если указанный фильтр null

removeAll

public boolean removeAll(Collection<?> c)

Описание скопировано из класса: AbstractCollection

Удаляет все элементы этой коллекции, которые также содержатся в указанной коллекции (необязательная операция). После возврата этого вызова эта коллекция не будет содержать общих элементов с указанной коллекцией.

Specified by:

removeAll в интерфейсе Collection<E>

Overrides:

removeAll в классе AbstractCollection<E>

Parameters:

c - коллекция, содержащая элементы, которые необходимо удалить из этой коллекции

Returns:

true если эта коллекция изменилась в результате вызова

Throws:

NullPointerException - если эта коллекция содержит один или несколько элементов null, а указанная коллекция не поддерживает элементы null (необязательно), или если указанная коллекция null

See Also:

retainAll

public boolean retainAll(Collection<?> c)

Описание, скопированное из класса: AbstractCollection

Оставляет только элементы в этом наборе, которые содержатся в указанном наборе (необязательная операция). Другими словами, удаляет из этого набора все его элементы, которые не содержатся в указанном наборе.

Определено в:

retainAll в интерфейсе Collection<E>

Переопределяет:

retainAll в классе AbstractCollection<E>

Параметры:

c - набор, содержащий элементы, которые должны быть сохранены в этом наборе

Возвращает:

true если этот набор изменился в результате вызова

Исключения:

NullPointerException - если этот набор содержит один или несколько нулевых элементов, а указанный набор не допускает нулевых элементов (необязательно), или если указанный набор равен null

См. также:

© 1993, 2021, 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/17/docs/api/java.base/java/util/concurrent/LinkedBlockingQueue.html