Spec-Zone.ru › OpenJDK 27

Класс LinkedBlockingQueue<E>

java.lang.Object
java.util.AbstractCollection<E>
java.util.AbstractQueue<E>
java.util.concurrent.LinkedBlockingQueue<E>
Параметры типа:
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.

С версии:
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)
Возвращает массив, содержащий все элементы этой очереди в правильном порядке; тип возвращаемого массива во время выполнения совпадает с типом указанного массива.

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

add, addAll, element, remove
Модификатор и тип Метод Описание
boolean add(E e)
Вставляет указанный элемент в эту очередь, если это можно сделать немедленно, не нарушая ограничений емкости; при успехе возвращает true, а если место сейчас недоступно, выбрасывает IllegalStateException.
boolean addAll(Collection<? extends E> c)
Добавляет все элементы указанной коллекции в эту очередь.
E element()
Извлекает, но не удаляет элемент из головы этой очереди.
E remove()
Извлекает и удаляет элемент из головы этой очереди.

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

containsAll, isEmpty, toString
Модификатор и тип Метод Описание
boolean containsAll(Collection<?> c)
Возвращает true, если эта коллекция содержит все элементы указанной коллекции.
boolean isEmpty()
Возвращает true, если эта коллекция не содержит элементов.
String toString()
Возвращает строковое представление этой коллекции.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Модификатор и тип Метод Описание
protected Object clone()
Создает и возвращает копию этого объекта.
boolean equals(Object obj)
Указывает, является ли другой объект «равным» этому объекту.
protected void finalize()
Устарело, будет удалено: этот элемент API может быть удален в будущей версии.
Финализация устарела и будет удалена в одном из будущих выпусков.
final Class<?> getClass()
Возвращает класс времени выполнения этого Object.
int hashCode()
Возвращает значение хеш-кода этого объекта.
final void notify()
Пробуждает один поток, ожидающий на мониторе этого объекта.
final void notifyAll()
Пробуждает все потоки, ожидающие на мониторе этого объекта.
final void wait()
Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания.
final void wait(long timeoutMillis)
Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо до истечения заданного интервала реального времени.
final void wait(long timeoutMillis, int nanos)
Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо до истечения заданного интервала реального времени.

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

add
Модификатор и тип Метод Описание
boolean add(E e)
Вставляет указанный элемент в эту очередь, если это можно сделать немедленно, не нарушая ограничений емкости; при успехе возвращает true, а если место сейчас недоступно, выбрасывает IllegalStateException.

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

equals, hashCode, parallelStream, stream, toArray
Модификатор и тип Метод Описание
boolean equals(Object o)
Сравнивает указанный объект с этой коллекцией на равенство.
int hashCode()
Возвращает значение хеш-кода этой коллекции.
default Stream<E> parallelStream()
Возвращает, возможно, параллельный Stream, источником которого является эта коллекция.
default Stream<E> stream()
Возвращает последовательный Stream, источником которого является эта коллекция.
default <T> T[] toArray(IntFunction<T[]> generator)
Возвращает массив, содержащий все элементы этой коллекции; для создания возвращаемого массива используется указанная функция generator.

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

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 на основе массивов и API на основе коллекций. Кроме того, этот метод позволяет точно контролировать тип выходного массива во время выполнения и при определенных обстоятельствах может использоваться для сокращения затрат на выделение памяти.

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

 String[] y = x.toArray(new String[0]);
Обратите внимание, что toArray(new Object[0]) функционально идентичен toArray().
Определено в:
toArray в интерфейсе Collection<E>
Переопределено:
toArray в классе AbstractCollection<E>
Параметры типа:
T — тип компонентов массива, в котором будет храниться коллекция
Параметры:
a — массив, в который следует поместить элементы очереди, если он достаточно велик; в противном случае для этой цели выделяется новый массив того же типа во время выполнения
Возвращает:
массив, содержащий все элементы этой очереди
Исключения:
ArrayStoreException — если тип указанного массива во время выполнения не является суперклассом типа во время выполнения каждого элемента этой очереди
NullPointerException — если указанный массив равен null

clear

public void clear()
Атомарно удаляет все элементы из этой очереди. После возврата из этого вызова очередь будет пуста.
Определено в:
clear в интерфейсе Collection<E>
Переопределено:
clear в классе AbstractQueue<E>

drainTo

public int drainTo(Collection<? super E> c)
Описание скопировано из интерфейса: BlockingQueue
Удаляет все доступные элементы из этой очереди и добавляет их в указанную коллекцию. Эта операция может быть эффективнее, чем многократный вызов метода poll для этой очереди. Сбой при попытке добавить элементы в коллекцию c может привести к тому, что в момент выбрасывания соответствующего исключения элементы окажутся ни в одной, в одной или в обеих коллекциях. Попытка переместить элементы очереди в нее саму приводит к IllegalArgumentException. Кроме того, поведение этой операции не определено, если указанная коллекция изменяется во время ее выполнения.
Определено в:
drainTo в интерфейсе BlockingQueue<E>
Параметры:
c — коллекция, в которую нужно перенести элементы
Возвращает:
количество перенесенных элементов
Исключения:
UnsupportedOperationException — если указанная коллекция не поддерживает добавление элементов
ClassCastException — если класс элемента этой очереди препятствует его добавлению в указанную коллекцию
NullPointerException — если указанная коллекция равна null
IllegalArgumentException — если указанная коллекция является этой очередью или какое-либо свойство элемента этой очереди препятствует его добавлению в указанную коллекцию

drainTo

public int drainTo(Collection<? super E> c, int maxElements)
Описание скопировано из интерфейса: BlockingQueue
Удаляет не более указанного количества доступных элементов из этой очереди и добавляет их в указанную коллекцию. Сбой при попытке добавить элементы в коллекцию c может привести к тому, что в момент выбрасывания соответствующего исключения элементы окажутся ни в одной, в одной или в обеих коллекциях. Попытка переместить элементы очереди в нее саму приводит к IllegalArgumentException. Кроме того, поведение этой операции не определено, если указанная коллекция изменяется во время ее выполнения.
Определено в:
drainTo в интерфейсе BlockingQueue<E>
Параметры:
c — коллекция, в которую нужно перенести элементы
maxElements — максимальное количество элементов для переноса
Возвращает:
количество перенесенных элементов
Исключения:
UnsupportedOperationException — если указанная коллекция не поддерживает добавление элементов
ClassCastException — если класс элемента этой очереди препятствует его добавлению в указанную коллекцию
NullPointerException — если указанная коллекция равна null
IllegalArgumentException — если указанная коллекция является этой очередью или какое-либо свойство элемента этой очереди препятствует его добавлению в указанную коллекцию

iterator

public Iterator<E> iterator()
Возвращает итератор элементов этой очереди в правильном порядке. Элементы возвращаются от первого (начала) к последнему (концу).

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

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

spliterator

public Spliterator<E> spliterator()
Возвращает Spliterator для элементов этой очереди.

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

Spliterator сообщает характеристики Spliterator.CONCURRENT, Spliterator.ORDERED и Spliterator.NONNULL.

Определено в:
spliterator в интерфейсе Collection<E>
Определено в:
spliterator в интерфейсе Iterable<E>
Примечание по реализации:
Spliterator реализует trySplit, чтобы обеспечить ограниченный параллелизм.
Возвращает:
Spliterator для элементов этой очереди
С версии:
1.8

forEach

public void forEach(Consumer<? super E> action)
Описание скопировано из интерфейса: Iterable
Выполняет указанное действие для каждого элемента Iterable, пока не будут обработаны все элементы или действие не выбросит исключение. Если порядок итерации определен, действия выполняются в этом порядке. Исключения, выброшенные действием, передаются вызывающему коду.

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

Определено в:
forEach в интерфейсе Iterable<E>
Параметры:
action — действие, которое нужно выполнить для каждого элемента
Исключения:
NullPointerException — если указанное действие равно null

removeIf

public boolean removeIf(Predicate<? super E> filter)
Описание скопировано из интерфейса: Collection
Удаляет из этой коллекции все элементы, удовлетворяющие заданному предикату (необязательная операция). Ошибки или исключения времени выполнения, возникшие во время итерации или при выполнении предиката, передаются вызывающему коду.
Определено в:
removeIf в интерфейсе Collection<E>
Параметры:
filter — предикат, возвращающий true для элементов, которые нужно удалить
Возвращает:
true, если были удалены какие-либо элементы
Исключения:
NullPointerException — если указанный фильтр равен null

removeAll

public boolean removeAll(Collection<?> c)
Описание скопировано из класса: AbstractCollection
Удаляет из этой коллекции все элементы, которые также содержатся в указанной коллекции (необязательная операция). После возврата из этого вызова у коллекций не будет общих элементов.
Определено в:
removeAll в интерфейсе Collection<E>
Переопределено:
removeAll в классе AbstractCollection<E>
Параметры:
c — коллекция, содержащая элементы, которые нужно удалить из этой коллекции
Возвращает:
true, если в результате вызова эта коллекция изменилась
Исключения:
NullPointerException — если эта коллекция содержит один или несколько элементов null, а указанная коллекция не поддерживает элементы null (необязательно), или если указанная коллекция равна null
См. также:
  • AbstractCollection.remove(Object)
  • AbstractCollection.contains(Object)

retainAll

public boolean retainAll(Collection<?> c)
Описание скопировано из класса: AbstractCollection
Оставляет в этой коллекции только элементы, содержащиеся в указанной коллекции (необязательная операция). Другими словами, удаляет из этой коллекции все элементы, которых нет в указанной коллекции.
Определено в:
retainAll в интерфейсе Collection<E>
Переопределено:
retainAll в классе AbstractCollection<E>
Параметры:
c — коллекция, содержащая элементы, которые нужно сохранить в этой коллекции
Возвращает:
true, если в результате вызова эта коллекция изменилась
Исключения:
NullPointerException — если эта коллекция содержит один или несколько элементов null, а указанная коллекция не допускает элементы null (необязательно), или если указанная коллекция равна null
См. также:
  • AbstractCollection.remove(Object)
  • AbstractCollection.contains(Object)

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, концептуальные обзоры, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторские права © 1993, 2026, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API