Класс LinkedBlockingQueue<E>

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

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

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

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

Конструкторы

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>

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

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

Возвращает:

количество элементов в этой очереди

remainingCapacity

public int 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 в интерфейсе Collection<E>

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

remove в интерфейсе BlockingQueue<E>

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

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

Параметры:

o - элемент, который нужно удалить из этой очереди, если он присутствует

Возвращает:

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

contains

public boolean contains(Object o)

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

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

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

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

contains в интерфейсе BlockingQueue<E>

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

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

Параметры:

o - объект, который нужно проверить на наличие в этой очереди

Возвращает:

true если эта очередь содержит указанный элемент

toArray

public Object[] toArray()

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

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

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

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

Возвращает:

массив, содержащий все элементы этой очереди

toArray

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

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

Указано в:

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

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

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

Параметры типа:

T - тип времени выполнения массива для хранения коллекции

Параметры:

a - массив, в который должны быть помещены элементы очереди, если он достаточно большой; в противном случае для этой цели выделяется новый массив того же типа времени выполнения

Возвращает:

массив, содержащий все элементы в этой очереди

Выбрасывает:

ArrayStoreException - если тип времени выполнения указанного массива не является супертипом типа времени выполнения каждого элемента в этой очереди

NullPointerException - если указанный массив null

toString

public String toString()

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

Возвращает строковое представление этой коллекции. Строковое представление состоит из списка элементов коллекции в порядке их возвращения итератором, заключенными в квадратные скобки ("[]"). Смежные элементы разделены символами ", " (запятая и пробел). Элементы преобразуются в строки как в String.valueOf(Object).

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

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

Возвращает:

строковое представление этой коллекции

clear

public void clear()

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

Указано в:

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

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

clear в классе AbstractQueue<E>

drainTo

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

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

Удаляет все доступные элементы из этой очереди и добавляет их в заданную коллекцию. Эта операция может быть более эффективной, чем многократное опрошение этой очереди. Ошибка, возникшая при попытке добавить элементы в коллекцию 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 в интерфейсе Iterable<E>

Указано в:

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

Указано в:

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

Возвращает:

итератор по элементам в этой очереди в правильном порядке

spliterator

public Spliterator<E> spliterator()

Указано в:

spliterator в интерфейсе Iterable<E>

Указано в:

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

Примечание реализации:

Этот Spliterator реализует trySplit для разрешения ограниченной параллельности.

Возвращает:

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

С:

1.8