java.util.concurrent

Класс LinkedTransferQueue <E>

java.lang. Объект

java.util. AbstractCollection<E>

java.util. AbstractQueue <E>

java.util.concurrent.LinkedTransferQueue<E>

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

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

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

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

public class LinkedTransferQueue<E>
extends AbstractQueue<E>
implements TransferQueue<E>, Serializable

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

Остерегайтесь этого, в отличие от этого в большинстве наборов, size метод НЕ является постоянно-разовой работой. Из-за асинхронной природы этих очередей, определяя текущее число элементов требует обхода элементов, и так может сообщить о неточных результатах, если этот набор изменяется во время обхода. Дополнительно, объемные операции addAll, removeAll, retainAll, containsAll, equals, и toArray как гарантируют, не будут выполнены атомарно. Например, iterator, работающий одновременно с addAll работа могла бы просмотреть только некоторые из добавленных элементов.

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

Эффекты непротиворечивости памяти: Как с другими параллельными наборами, действиями в потоке до размещения объекта в a LinkedTransferQueue произойдите - перед действиями, последующими за доступом или удалением того элемента от LinkedTransferQueue в другом потоке.

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

С тех пор:

1.7

См. Также:

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

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

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

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

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

Методы

Модификатор и Тип	Метод и Описание
boolean	add(E e) Вставляет указанный элемент в хвосте этой очереди.
boolean	contains(Object o) Возвраты true если эта очередь содержит указанный элемент.
int	drainTo(Collection<? super E> c) Удаляет все доступные элементы из этой очереди и добавляет их к данному набору.
int	drainTo(Collection<? super E> c, int maxElements) Удаляет самое большее данное число доступных элементов от этой очереди и добавляет их к данному набору.
int	getWaitingConsumerCount() Возвращает оценку числа потребителей, ожидающего, чтобы получить элементы через BlockingQueue.take() или синхронизированный poll.
boolean	hasWaitingConsumer() Возвраты true если есть по крайней мере один потребитель, ожидающий, чтобы получить элемент через BlockingQueue.take() или синхронизированный poll.
boolean	isEmpty() Возвраты true если эта очередь не содержит элементов.
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 потому что a LinkedTransferQueue не ограниченная емкость.
boolean	remove(Object o) Удаляет единственный экземпляр указанного элемента от этой очереди, если это присутствует.
int	size() Возвращает число элементов в этой очереди.
E	take() Получает и удаляет главу этой очереди, ожидая в случае необходимости, пока элемент не становится доступным.
void	transfer(E e) Передает элемент потребителю, ожидая в случае необходимости, чтобы сделать так.
boolean	tryTransfer(E e) Передает элемент ожидающему потребителю сразу, если возможный.
boolean	tryTransfer(E e, long timeout, TimeUnit unit) Передает элемент потребителю, если возможно сделать так прежде, чем тайм-аут протекает.

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

addAll, clear, element, remove

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

containsAll, removeAll, retainAll, toArray, toArray, toString

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

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

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

element, remove

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

addAll, clear, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

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

LinkedTransferQueue

public LinkedTransferQueue()

Создает первоначально пустой LinkedTransferQueue.

LinkedTransferQueue

public LinkedTransferQueue(Collection<? extends E> c)

Создает a LinkedTransferQueue первоначально содержа элементы данного набора, добавленного в порядке обхода iterator набора.

Параметры:

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

Броски:

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

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

поместить

public void put(E e)

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

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

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

Параметры:

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

Броски:

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

предложение

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

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

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

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

Параметры:

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

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

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

Возвраты:

true (как определено BlockingQueue.offer)

Броски:

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

предложение

public boolean offer(E e)

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

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

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

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

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

Параметры:

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

Возвраты:

true (как определено Queue.offer(E))

Броски:

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

добавить

public boolean add(E e)

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

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

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

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

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

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

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

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

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

Параметры:

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

Возвраты:

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

Броски:

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

tryTransfer

public boolean tryTransfer(E e)

Передает элемент ожидающему потребителю сразу, если возможный.

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

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

tryTransfer в интерфейсе TransferQueue<E>

Параметры:

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

Возвраты:

true если элемент был передан, еще false

Броски:

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

передача

public void transfer(E e)
              throws InterruptedException

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

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

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

transfer в интерфейсе TransferQueue<E>

Параметры:

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

Броски:

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

InterruptedException - если прервано, ожидая, когда элемент не оставляют ставившим в очередь

tryTransfer

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

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

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

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

tryTransfer в интерфейсе TransferQueue<E>

Параметры:

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

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

unit - a TimeUnit определение, как интерпретировать timeout параметр

Возвраты:

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

Броски:

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

InterruptedException - если прервано, ожидая, когда элемент не оставляют ставившим в очередь

взять

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

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

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

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

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

Возвраты:

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

drainTo

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

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

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

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

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

Параметры:

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

Возвраты:

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

Броски:

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

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

drainTo

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

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

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

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

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

Параметры:

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

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

Возвраты:

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

Броски:

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

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

iterator

public Iterator<E> iterator()

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

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

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

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

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

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

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

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

Возвраты:

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

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

public E peek()

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

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

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

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

Возвраты:

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

isEmpty

public boolean isEmpty()

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

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

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

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

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

Возвраты:

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

hasWaitingConsumer

public boolean hasWaitingConsumer()

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

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

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

hasWaitingConsumer в интерфейсе TransferQueue<E>

Возвраты:

true если есть по крайней мере один ожидающий потребитель

размер

public int size()

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

Остерегайтесь этого, в отличие от этого в большинстве наборов, этот метод НЕ является постоянно-разовой работой. Из-за асинхронной природы этих очередей, определяя текущее число элементов требует O (n) обход.

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

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

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

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

Возвраты:

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

getWaitingConsumerCount

public int getWaitingConsumerCount()

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

Возвращает оценку числа потребителей, ожидающего, чтобы получить элементы через BlockingQueue.take() или синхронизированный poll. Возвращаемое значение является приближением мгновенного положения дел, которое может быть неточным, если потребители завершились или бросили ожидать. Значение может быть полезным для контроля и эвристики, но не для управления синхронизацией. Реализации этого метода, вероятно, будут заметно медленнее чем те для TransferQueue.hasWaitingConsumer().

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

getWaitingConsumerCount в интерфейсе TransferQueue<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 если эта очередь содержит указанный элемент

remainingCapacity

public int remainingCapacity()

Всегда возвраты Integer.MAX_VALUE потому что a LinkedTransferQueue не ограниченная емкость.

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

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

Возвраты:

Integer.MAX_VALUE (как определено BlockingQueue.remainingCapacity())