java.util.concurrent

Класс ArrayBlockingQueue <E>

java.lang. Объект

java.util. AbstractCollection<E>

java.util. AbstractQueue <E>

java.util.concurrent.ArrayBlockingQueue<E>

Введите Параметры:

E - тип элементов сохранен в этом наборе

Все Реализованные Интерфейсы:

Сериализуемый, Повторяемый <E>, Набор <E>, BlockingQueue <E>, Очередь <E>

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

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

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

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

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

Этот класс является элементом Платформы Наборов Java.

С тех пор:

1.5

См. Также:

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

Сводка конструктора

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

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

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
boolean	add(E e) Вставляет указанный элемент в хвосте этой очереди, если возможно сделать так сразу, не превышая емкость очереди, возвращаясь true на успех и бросок IllegalStateException если эта очередь полна.
void	clear() Атомарно удаляет все элементы от этой очереди.
boolean	contains(Object o) Возвраты true если эта очередь содержит указанный элемент.
int	drainTo(Collection<? super E> c) Удаляет все доступные элементы из этой очереди и добавляет их к данному набору.
int	drainTo(Collection<? super E> c, int maxElements) Удаляет самое большее данное число доступных элементов от этой очереди и добавляет их к данному набору.
Iterator<E>	iterator() Возвращает 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) Удаляет единственный экземпляр указанного элемента от этой очереди, если это присутствует.
int	size() Возвращает число элементов в этой очереди.
E	take() Получает и удаляет главу этой очереди, ожидая в случае необходимости, пока элемент не становится доступным.
Объект[]	toArray() Возвращает массив, содержащий все элементы в этой очереди, в надлежащей последовательности.
<T> T[]	toArray(T[] a) Возвращает массив, содержащий все элементы в этой очереди, в надлежащей последовательности; тип времени выполнения возвращенного массива является типом указанного массива.
Строка	toString() Возвращает строковое представление этого набора.

Методы java.util унаследованный от класса. AbstractQueue

addAll, element, remove

Методы java.util унаследованный от класса. AbstractCollection

containsAll, isEmpty, removeAll, retainAll

Методы java.lang унаследованный от класса. Объект

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

Методы, наследованные от интерфейса java.util. Очередь

element, remove

Методы, наследованные от интерфейса java.util. Набор

addAll, containsAll, equals, hashCode, isEmpty, removeAll, retainAll

Деталь конструктора

ArrayBlockingQueue

public ArrayBlockingQueue(int capacity)

Создает ArrayBlockingQueue с данной (фиксированной) емкостью и политикой доступа по умолчанию.

Параметры:

capacity - емкость этой очереди

Броски:

IllegalArgumentException - если capacity < 1

ArrayBlockingQueue

public ArrayBlockingQueue(int capacity,
                  boolean fair)

Создает ArrayBlockingQueue с данной (фиксированной) емкостью и указанной политикой доступа.

Параметры:

capacity - емкость этой очереди

fair - если true тогда доступы очереди для потоков, блокированных на вставке или удалении, обрабатываются в порядке FIFO; если false порядок доступа является неуказанным.

Броски:

IllegalArgumentException - если capacity < 1

ArrayBlockingQueue

public ArrayBlockingQueue(int capacity,
                  boolean fair,
                  Collection<? extends E> c)

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

Параметры:

capacity - емкость этой очереди

fair - если true тогда доступы очереди для потоков, блокированных на вставке или удалении, обрабатываются в порядке FIFO; если false порядок доступа является неуказанным.

c - набор элементов, чтобы первоначально содержать

Броски:

IllegalArgumentException - если capacity меньше чем c.size(), или меньше чем 1.

NullPointerException - если указанный набор или какой-либо из его элементов являются нулем

Деталь метода

добавить

public boolean add(E e)

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

Определенный:

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

Определенный:

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

Определенный:

add в интерфейсе Queue<E>

Переопределения:

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

Параметры:

e - элемент, чтобы добавить

Возвраты:

true (как определено Collection.add(E))

Броски:

IllegalStateException - если эта очередь полна

NullPointerException - если указанный элемент является нулем

предложение

public boolean offer(E e)

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

Определенный:

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

Определенный:

offer в интерфейсе Queue<E>

Параметры:

e - элемент, чтобы добавить

Возвраты:

true, если элемент был добавлен к этой очереди, еще false

Броски:

NullPointerException - если указанный элемент является нулем

поместить

public void put(E e)
         throws InterruptedException

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

Определенный:

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

Параметры:

e - элемент, чтобы добавить

Броски:

InterruptedException - если прервано, ожидая

NullPointerException - если указанный элемент является нулем

предложение

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

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

Определенный:

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

Параметры:

e - элемент, чтобы добавить

timeout - сколько времени ожидать перед отказом в модулях unit

unit - TimeUnit, определяющий, как интерпретировать параметр timeout

Возвраты:

true в случае успеха, или false, если указанное время ожидания протекает перед пространством, доступен

Броски:

InterruptedException - если прервано, ожидая

NullPointerException - если указанный элемент является нулем

опрос

public E poll()

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

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

Определенный:

poll в интерфейсе Queue<E>

Возвраты:

глава этой очереди, или null, если эта очередь пуста

взять

public E take()
       throws InterruptedException

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

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

Определенный:

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

Возвраты:

глава этой очереди

Броски:

InterruptedException - если прервано, ожидая

опрос

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

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

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

Определенный:

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

Параметры:

timeout - сколько времени ожидать перед отказом в модулях unit

unit - TimeUnit, определяющий, как интерпретировать параметр timeout

Возвраты:

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

Броски:

InterruptedException - если прервано, ожидая

быстрый взгляд

public E peek()

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

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

Определенный:

peek в интерфейсе Queue<E>

Возвраты:

глава этой очереди, или null, если эта очередь пуста

размер

public int size()

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

Определенный:

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

Определенный:

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

Возвраты:

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

remainingCapacity

public int remainingCapacity()

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

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

Определенный:

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

Возвраты:

остающаяся емкость

удалить

public boolean remove(Object o)

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

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

Определенный:

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

Определенный:

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

Переопределения:

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

Параметры:

o - элемент, который будет удален из этой очереди, если существующий

Возвраты:

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

содержит

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()

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

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

Этот метод действует как мост между основанными на массиве и основанными на наборе 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().

Определенный:

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

Переопределения:

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

Параметры:

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

Возвраты:

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

Броски:

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

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

toString

public String toString()

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

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

Переопределения:

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

Возвраты:

строковое представление этого набора

очистить

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 - если указанный набор является нулем

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

drainTo

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

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

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

Определенный:

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

Параметры:

c - набор, чтобы передать элементы в

maxElements - максимальное количество элементов, чтобы передать

Возвраты:

число элементов передается

Броски:

UnsupportedOperationException - если добавление элементов не поддерживается указанным набором

ClassCastException - если класс элемента этой очереди препятствует тому, чтобы это было добавлено к указанному набору

NullPointerException - если указанный набор является нулем

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

iterator

public Iterator<E> iterator()

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

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

Определенный:

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

Определенный:

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

Определенный:

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

Возвраты:

iterator по элементам в этой очереди в надлежащей последовательности