java.util.concurrent

Класс PriorityBlockingQueue <E>

java.lang. Объект

java.util. AbstractCollection<E>

java.util. AbstractQueue <E>

java.util.concurrent.PriorityBlockingQueue<E>

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

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

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

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

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

Неограниченная очередь блокирования, которая использует те же самые правила упорядочивания в качестве класса PriorityQueue и предоставления, блокирующие операции извлечения. В то время как эта очередь является логически неограниченными, предпринятыми дополнениями, может перестать работать из-за исчерпания ресурса (порождение OutOfMemoryError). Этот класс не разрешает null элементы. Приоритетная очередь, полагающаяся на естественное упорядочивание также, не разрешает вставку несопоставимых объектов (выполнение так результаты в ClassCastException).

Этот класс и его iterator реализуют все дополнительные методы Collection и Iterator интерфейсы. Iterator обеспечил в методе iterator() как гарантируют, не пересечет элементы PriorityBlockingQueue в любом определенном порядке. Если Вы нуждаетесь в упорядоченном обходе, рассматриваете использование Arrays.sort(pq.toArray()). Кроме того, метод drainTo может использоваться, чтобы удалить некоторых или все элементы в первоочередном заказе и разместить их в другой набор.

Операции на этом классе не делают гарантий об упорядочивании элементов с равным приоритетом. Если Вы должны осуществить упорядочивание, можно определить пользовательские классы или компараторы, которые используют вторичный ключ, чтобы повредиться, связывает основные приоритетные значения. Например, вот класс, который применяет первым прибыл - первым убыл повреждение связи к сопоставимым элементам. Чтобы использовать это, Вы вставили бы a new FIFOEntry(anEntry) вместо простого объекта записи.

 class FIFOEntry<E extends Comparable<? super E>>
     implements Comparable<FIFOEntry<E>> {
   static final AtomicLong seq = new AtomicLong(0);
   final long seqNum;
   final E entry;
   public FIFOEntry(E entry) {
     seqNum = seq.getAndIncrement();
     this.entry = entry;
   }
   public E getEntry() { return entry; }
   public int compareTo(FIFOEntry<E> other) {
     int res = entry.compareTo(other.entry);
     if (res == 0 && other.entry != this.entry)
       res = (seqNum < other.seqNum ? -1 : 1);
     return res;
   }
 }

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

С тех пор:

1.5

См. Также:

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

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

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

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

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

Методы

Модификатор и Тип	Метод и Описание
boolean	add(E e) Вставляет указанный элемент в эту приоритетную очередь.
void	clear() Атомарно удаляет все элементы от этой очереди.
Comparator<? super E>	comparator() Возвращает компаратор, используемый, чтобы упорядочить элементы в этой очереди, или null если эта очередь использует естественное упорядочивание своих элементов.
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) Вставляет указанный элемент в эту приоритетную очередь.
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 PriorityBlockingQueue не ограниченная емкость.
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

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

PriorityBlockingQueue

public PriorityBlockingQueue()

Создает a PriorityBlockingQueue с начальной емкостью по умолчанию (11), который упорядочивает ее элементы согласно их естественному упорядочиванию.

PriorityBlockingQueue

public PriorityBlockingQueue(int initialCapacity)

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

Параметры:

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

Броски:

IllegalArgumentException - если initialCapacity меньше чем 1

PriorityBlockingQueue

public PriorityBlockingQueue(int initialCapacity,
                     Comparator<? super E> comparator)

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

Параметры:

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

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

Броски:

IllegalArgumentException - если initialCapacity меньше чем 1

PriorityBlockingQueue

public PriorityBlockingQueue(Collection<? extends E> c)

Создает a PriorityBlockingQueue содержа элементы в указанном наборе. Если указанный набор является a SortedSet или a PriorityQueue, этой приоритетной очереди упорядочат согласно тому же самому упорядочиванию. Иначе, этой приоритетной очереди упорядочат согласно естественному упорядочиванию ее элементов.

Параметры:

c - набор, элементы которого должны быть помещены в эту приоритетную очередь

Броски:

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

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

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

добавить

public boolean add(E e)

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

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

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

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

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

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

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

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

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

Параметры:

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

Возвраты:

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

Броски:

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

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

предложение

public boolean offer(E e)

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

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

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

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

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

Параметры:

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

Возвраты:

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

Броски:

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

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

поместить

public void put(E e)

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

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

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

Параметры:

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

Броски:

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

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

предложение

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

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

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

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

Параметры:

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

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

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

Возвраты:

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

Броски:

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

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 Comparator<? super E> comparator()

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

Возвраты:

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

размер

public int size()

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

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

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

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

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

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

Возвраты:

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

remainingCapacity

public int remainingCapacity()

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

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

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

Возвраты:

Integer.MAX_VALUE всегда

удалить

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>

Возвраты:

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

toString

public String toString()

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

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

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

toString в классе AbstractCollection<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 - если указанный набор является этой очередью, или некоторое свойство элемента этой очереди препятствует тому, чтобы это было добавлено к указанному набору

очистить

public void clear()

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

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

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

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

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

iterator

public Iterator<E> iterator()

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

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

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

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

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

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

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

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

Возвраты:

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