Класс SynchronousQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

java.util.concurrent.SynchronousQueue<E>

Параметры типа:: E — тип элементов, хранящихся в этой очереди

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

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

Блокирующая очередь, в которой каждая операция вставки должна ожидать соответствующей операции извлечения, выполняемой другим потоком, и наоборот. Синхронная очередь не имеет внутренней ёмкости, даже равной единице. Нельзя peek в синхронной очереди, поскольку элемент присутствует в ней, только когда вы пытаетесь его извлечь; нельзя вставить элемент (с помощью любого метода), если другой поток не пытается его извлечь; нельзя выполнять итерацию, поскольку перебирать нечего. Голова очереди — это элемент, который первый ожидающий поток-вставитель пытается добавить в очередь; если такого ожидающего потока нет, то элементы недоступны для извлечения, и poll() вернёт null. Для целей других методов Collection (например, contains) SynchronousQueue ведёт себя как пустая коллекция. Эта очередь не допускает элементы null.

Синхронные очереди похожи на каналы rendezvous, используемые в CSP и Ada. Они хорошо подходят для схем передачи управления, в которых объект, работающий в одном потоке, должен синхронизироваться с объектом, работающим в другом потоке, чтобы передать ему некоторую информацию, событие или задачу.

Этот класс поддерживает необязательную политику справедливости при упорядочивании ожидающих потоков-производителей и потоков-потребителей. По умолчанию этот порядок не гарантируется. Однако очередь, созданная с включённой справедливостью true, предоставляет потокам доступ в порядке FIFO.

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

Этот класс является частью Java Collections Framework.

Начиная с версии:

1.5

См. также:

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

Конструктор	Описание
`SynchronousQueue()`	Создаёт `SynchronousQueue` с политикой доступа без обеспечения справедливости.
`SynchronousQueue(boolean fair)`	Создаёт `SynchronousQueue` с указанной политикой справедливости.

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

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

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

add, addAll, element, remove

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

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

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

add

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

addAll, equals, hashCode, parallelStream, removeIf, stream, toArray

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

forEach

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

element, remove

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

SynchronousQueue

public SynchronousQueue()

Создаёт SynchronousQueue с политикой доступа без обеспечения справедливости.

SynchronousQueue

public SynchronousQueue(boolean fair)

Создаёт SynchronousQueue с указанной политикой справедливости.

Параметры:: fair — если значение true, ожидающие потоки конкурируют за доступ в порядке FIFO; в противном случае порядок не определён.

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

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)

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

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

take

public E take() throws InterruptedException

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

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

poll

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

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

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

poll

public E poll()

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

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

isEmpty

public boolean isEmpty()

Всегда возвращает true. SynchronousQueue не имеет внутренней ёмкости.

Переопределяет:: isEmpty в интерфейсе Collection<E>
Переопределяет:: isEmpty в классе AbstractCollection<E>
Возвращает:: true

size

public int size()

Всегда возвращает ноль. SynchronousQueue не имеет внутренней ёмкости.

Переопределяет:: size в интерфейсе Collection<E>
Возвращает:: ноль

remainingCapacity

public int remainingCapacity()

Всегда возвращает ноль. SynchronousQueue не имеет внутренней ёмкости.

Переопределяет:: remainingCapacity в интерфейсе BlockingQueue<E>
Возвращает:: ноль

clear

public void clear()

Ничего не делает. SynchronousQueue не имеет внутренней ёмкости.

Переопределяет:: clear в интерфейсе Collection<E>
Переопределяет:: clear в классе AbstractQueue<E>

contains

public boolean contains(Object o)

Всегда возвращает false. SynchronousQueue не имеет внутренней ёмкости.

Переопределяет:: contains в интерфейсе BlockingQueue<E>
Переопределяет:: contains в интерфейсе Collection<E>
Переопределяет:: contains в классе AbstractCollection<E>
Параметры:: o — элемент
Возвращает:: false

remove

public boolean remove(Object o)

Всегда возвращает false. SynchronousQueue не имеет внутренней ёмкости.

Переопределяет:: remove в интерфейсе BlockingQueue<E>
Переопределяет:: remove в интерфейсе Collection<E>
Переопределяет:: remove в классе AbstractCollection<E>
Параметры:: o — удаляемый элемент
Возвращает:: false

containsAll

public boolean containsAll(Collection<?> c)

Возвращает false, если только указанная коллекция не пуста. SynchronousQueue не имеет внутренней ёмкости.

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

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

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

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

Параметры:

c — коллекция

Возвращает:

false, если указанная коллекция не пуста

См. также:

removeAll

public boolean removeAll(Collection<?> c)

Всегда возвращает false. SynchronousQueue не имеет внутренней ёмкости.

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

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

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

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

Параметры:

c — коллекция

Возвращает:

false

См. также:

retainAll

public boolean retainAll(Collection<?> c)

Всегда возвращает false. SynchronousQueue не имеет внутренней ёмкости.

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

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

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

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

Параметры:

c — коллекция

Возвращает:

false

См. также:

peek

public E peek()

Всегда возвращает null. SynchronousQueue не возвращает элементы, если поток активно не ожидает их.

Переопределяет:: peek в интерфейсе Queue<E>
Возвращает:: null

iterator

public Iterator<E> iterator()

Возвращает пустой итератор, у которого hasNext всегда возвращает false.

Переопределяет:: iterator в интерфейсе Collection<E>
Переопределяет:: iterator в интерфейсе Iterable<E>
Переопределяет:: iterator в классе AbstractCollection<E>
Возвращает:: пустой итератор

spliterator

public Spliterator<E> spliterator()

Возвращает пустой сплитератор, в котором вызовы trySplit всегда возвращают null.

Переопределяет:: spliterator в интерфейсе Collection<E>
Переопределяет:: spliterator в интерфейсе Iterable<E>
Возвращает:: пустой сплитератор
Начиная с версии:: 1.8

toArray

public Object[] toArray()

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

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

toArray

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

Устанавливает нулевой элемент указанного массива в null (если длина массива не равна нулю) и возвращает этот массив.

Переопределяет:: toArray в интерфейсе Collection<E>
Переопределяет:: toArray в классе AbstractCollection<E>
Параметры типа:: T — тип компонентов массива, предназначенного для хранения коллекции
Параметры:: a — массив
Возвращает:: указанный массив
Исключения:: NullPointerException — если указанный массив равен null

toString

public String toString()

Всегда возвращает "[]".

Переопределяет:: toString в классе AbstractCollection<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 — если указанная коллекция является этой очередью или какое-либо свойство элемента этой очереди не позволяет добавить его в указанную коллекцию

© 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/concurrent/SynchronousQueue.html