java.util.concurrent

Класс DelayQueue <E расширяется Задержанный>

java.lang. Объект

java.util. AbstractCollection<E>

java.util. AbstractQueue <E>

java.util.concurrent. DelayQueue <E>

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

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

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

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

public class DelayQueue<E extends Delayed>
extends AbstractQueue<E>
implements BlockingQueue<E>

Неограниченная очередь блокирования элементов Delayed, в которых может только быть взят элемент, когда его задержка истекла. Глава очереди то, что элемент Delayed чья задержка, истекшая дальше всего в прошлом. Если никакая задержка не истекла нет никакой головы, и poll возвратит null. Истечение происходит, когда метод getDelay(TimeUnit.NANOSECONDS) элемента возвращает значение, меньше чем или равное нулю. Даже при том, что неистекшие элементы не могут быть удалены, используя take или poll, они иначе обрабатываются как нормальные элементы. Например, метод size возвращает количество и истекших и неистекших элементов. Эта очередь не разрешает нулевые элементы.

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

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

С тех пор:

1.5

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

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

Конструктор и Описание
DelayQueue() Создает новый DelayQueue, который первоначально пуст.
DelayQueue(Collection<? extends E> c) Создает DelayQueue, первоначально содержащий элементы данного набора Delayed экземпляры.

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

Методы

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

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

addAll, element, remove

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

contains, containsAll, isEmpty, removeAll, retainAll, toString

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

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

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

содержит

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

element, remove

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

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

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

DelayQueue

public DelayQueue()

Создает новый DelayQueue, который первоначально пуст.

DelayQueue

public DelayQueue(Collection<? extends E> c)

Создает DelayQueue, первоначально содержащий элементы данного набора Delayed экземпляры.

Параметры:

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

Броски:

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

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

добавить

public boolean add(E e)

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

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

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

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

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

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

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

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

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

Параметры:

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

Возвраты:

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

Броски:

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

предложение

public boolean offer(E e)

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

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

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

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

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

Параметры:

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

Возвраты:

true

Броски:

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

поместить

public void put(E e)

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

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

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

Параметры:

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

Броски:

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

предложение

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

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

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

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

Параметры:

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

timeout - Этот параметр игнорируется, поскольку метод никогда не блокирует

unit - Этот параметр игнорируется, поскольку метод никогда не блокирует

Возвраты:

true

Броски:

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

опрос

public E poll()

Получает и удаляет главу этой очереди, или возвращает null, если у этой очереди нет никаких элементов с задержкой с истекшим сроком.

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

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

Возвраты:

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

взять

public E take()
                       throws InterruptedException

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

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

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

Возвраты:

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

Броски:

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

опрос

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

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

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

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

Параметры:

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

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

Возвраты:

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

Броски:

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

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

public E peek()

Получает, но не удаляет, глава этой очереди, или возвращает null, если эта очередь пуста. В отличие от poll, если никакие элементы с истекшим сроком не доступны в очереди, этот метод возвращает элемент, который истечет затем, если Вы будете существовать.

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

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

Возвраты:

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

размер

public int size()

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

Возвращает число элементов в этом наборе. Если этот набор содержит больше чем элементы Integer.MAX_VALUE, Integer.MAX_VALUE возвратов.

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

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

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

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

Возвраты:

число элементов в этом наборе

drainTo

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

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

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

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

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

Параметры:

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

Возвраты:

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

Броски:

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

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

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

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

drainTo

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

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

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

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

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

Параметры:

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

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

Возвраты:

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

Броски:

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

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

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

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

очистить

public void clear()

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

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

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

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

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

remainingCapacity

public int remainingCapacity()

Всегда Integer.MAX_VALUE возвратов, потому что DelayQueue не является ограниченной емкостью.

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

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

Возвраты:

Integer.MAX_VALUE

toArray

public Object[] toArray()

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

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

Этот метод действует как мост между основанными на массиве и основанными на наборе API.

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

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

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

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

Возвраты:

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

toArray

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

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

Если эта очередь помещается в указанный массив с комнатой, чтобы сэкономить (то есть, у массива есть больше элементов чем эта очередь), элемент в массиве сразу после конца очереди устанавливается в null.

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

Следующий код может использоваться, чтобы вывести очередь задержки в недавно выделенный массив Delayed:

     Delayed[] a = q.toArray(new Delayed[0]);

Отметьте, что toArray(new Object[0]) идентичен в функции toArray().

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

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

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

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

Параметры:

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

Возвраты:

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

Броски:

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

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

удалить

public boolean remove(Object o)

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

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

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

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

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

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

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

Параметры:

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

Возвраты:

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

iterator

public Iterator<E> iterator()

Возвращает iterator по всем элементам (и истекший и неистекший) в этой очереди. iterator не возвращает элементы в любом определенном порядке.

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

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

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

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

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

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

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

Возвраты:

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