Класс ArrayBlockingQueue<E>

public ArrayBlockingQueue(int capacity)

Параметры:

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

Исключения:

IllegalArgumentException - если capacity < 1

public ArrayBlockingQueue(int capacity, boolean fair)

Параметры:

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

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

Исключения:

IllegalArgumentException - если capacity < 1

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

Параметры:

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

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

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

Исключения:

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

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

public boolean add(E e)

Указано в:

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

Указано в:

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

Указано в:

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

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

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

Параметры:

e - элемент для добавления

Возвращает:

true (как указано в Collection.add(E))

Исключения:

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

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

public boolean offer(E e)

Указано в:

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

Указано в:

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

Параметры:

e - элемент для добавления

Возвращает:

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

Исключения:

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

public void put(E e) throws InterruptedException

Указано в:

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

Параметры:

e - элемент для добавления

Исключения:

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

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

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

public E poll()

Указано в:

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

Возвращает:

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

public E take() throws InterruptedException

Указано в:

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

Возвращает:

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

Исключения:

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

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

Указано в:

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

Параметры:

timeout - как долго ждать, прежде чем сдаться, в единицах unit

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

Возвращает:

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

Исключения:

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

public E peek()

Указано в:

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

Возвращает:

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

public int size()

Указано в:

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

Возвращает:

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

public int remainingCapacity()

Указано в:

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

Возвращает:

оставшаяся емкость

public boolean remove(Object o)

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

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

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

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

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

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

Параметры:

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

Возвращает:

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

public boolean contains(Object o)

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

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

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

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

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

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

Параметры:

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

Возвращает:

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

public Object[] toArray()

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

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

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

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

Возвращает:

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

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

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

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

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

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

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

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

T - компонентный тип массива, содержащего коллекцию

Параметры:

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

Возвращает:

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

Исключения:

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

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

public void clear()

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

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

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

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

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

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

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

Параметры:

c - коллекция, в которую нужно перенести элементы

Возвращает:

количество перенесённых элементов

Исключения:

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

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

NullPointerException - если указанная коллекция равна null

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

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

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

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

Параметры:

c - коллекция, в которую нужно перенести элементы

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

Возвращает:

количество перенесённых элементов

Исключения:

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

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

NullPointerException - если указанная коллекция равна null

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

public Iterator<E> iterator()

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

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

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

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

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

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

Возвращает:

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

public Spliterator<E> spliterator()

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

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

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

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

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

Spliterator реализует trySplit, чтобы разрешить ограниченное распараллеливание.

Возвращает:

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

С:

1.8

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

Указано в:

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

Параметры:

action - действие, которое нужно выполнить для каждого элемента

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

NullPointerException - если указанное действие равно null

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

Указано в:

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

Параметры:

filter - предикат, возвращающий true для элементов, которые нужно удалить

Возвращает:

true, если были удалены какие-либо элементы

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

NullPointerException - если указанный фильтр равен null

public boolean removeAll(Collection<?> c)

Указано в:

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

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

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

Параметры:

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

Возвращает:

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

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

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

См. также:

• AbstractCollection.remove(Object)
• AbstractCollection.contains(Object)

public boolean retainAll(Collection<?> c)

Указано в:

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

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

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

Параметры:

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

Возвращает:

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

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

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

См. также:

• AbstractCollection.remove(Object)
• AbstractCollection.contains(Object)