Класс PriorityBlockingQueue<E>
- Type Parameters:
-
E- тип элементов, хранящихся в этой очереди
- Все реализованные интерфейсы:
-
Serializable,Iterable<E>,Collection<E>,BlockingQueue<E>,Queue<E>
public class PriorityBlockingQueue<E> extends AbstractQueue<E> implements BlockingQueue<E>, Serializable
PriorityQueue, и предоставляет блокирующие операции извлечения. Хотя эта очередь логически неограничена, попытки добавления могут завершиться неудачей из-за исчерпания ресурсов (приводя к OutOfMemoryError). Этот класс не допускает null элементов. Очередь с приоритетами, использующая естественный порядок, также не допускает вставки несопоставимых объектов (в результате чего ClassCastException). Этот класс и его итератор реализуют все необязательные методы интерфейсов Collection и Iterator. Итератор, предоставляемый методом iterator(), и итератор Spliterator, предоставляемый методом spliterator(), не гарантируют прохождения элементов PriorityBlockingQueue в каком-либо определенном порядке. Если вам нужна упорядоченная итерация, рассмотрите возможность использования Arrays.sort(pq.toArray()). Также метод drainTo может быть использован для удаления некоторых или всех элементов в порядке приоритета и их размещения в другой коллекции.
Операции с этим классом не гарантируют порядок элементов с одинаковым приоритетом. Если вам необходимо принудительно установить порядок, вы можете определить пользовательские классы или компараторы, которые используют дополнительный ключ для разбиения связей в значениях первичного приоритета. Например, вот класс, который применяет порядок FIFO к сопоставимым элементам. Для его использования вы бы вставили new FIFOEntry(anEntry) вместо обычного объекта записи.
class FIFOEntry<E extends Comparable<? super E>>
implements Comparable<FIFOEntry<E>> {
static final AtomicLong seq = new AtomicLong();
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 Collections Framework.
- Since:
- 1.5
- See Also:
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
PriorityBlockingQueue() |
Создает PriorityBlockingQueue с исходной емкостью по умолчанию (11), которая упорядочивает элементы в соответствии с их естественным порядком. |
PriorityBlockingQueue |
Создает PriorityBlockingQueue с указанной исходной емкостью, которая упорядочивает элементы в соответствии с их естественным порядком. |
PriorityBlockingQueue |
Создает PriorityBlockingQueue с указанной исходной емкостью, которая упорядочивает элементы в соответствии с указанным компаратором. |
PriorityBlockingQueue |
Создает PriorityBlockingQueue, содержащий элементы в указанной коллекции. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
boolean |
add |
Вставляет указанный элемент в эту очередь с приоритетами. |
void |
clear() |
Атомарно удаляет все элементы из этой очереди. |
Comparator<? super E> |
comparator() |
Возвращает компаратор, используемый для упорядочивания элементов в этой очереди, или null если эта очередь использует естественный порядок своих элементов. |
boolean |
contains |
Возвращает true , если эта очередь содержит указанный элемент. |
int |
drainTo |
Удаляет все доступные элементы из этой очереди и добавляет их в заданную коллекцию. |
int |
drainTo |
Удаляет не более заданного количества доступных элементов из этой очереди и добавляет их в заданную коллекцию. |
void |
forEach |
Выполняет заданное действие для каждого элемента Iterable до тех пор, пока все элементы не будут обработаны или действие не вызовет исключение. |
Iterator<E> |
iterator() |
Возвращает итератор по элементам в этой очереди. |
boolean |
offer |
Вставляет указанный элемент в эту очередь с приоритетами. |
boolean |
offer |
Вставляет указанный элемент в эту очередь с приоритетами. |
E |
peek() |
Извлекает, но не удаляет, голову этой очереди или возвращает null , если эта очередь пуста. |
E |
poll() |
Извлекает и удаляет голову этой очереди или возвращает null , если эта очередь пуста. |
E |
poll |
Извлекает и удаляет голову этой очереди, ожидая до указанного времени ожидания, если необходимо, пока элемент не станет доступным. |
void |
put |
Вставляет указанный элемент в эту очередь с приоритетами. |
int |
remainingCapacity() |
Всегда возвращает Integer.MAX_VALUE , потому что PriorityBlockingQueue не ограничена емкостью. |
boolean |
remove |
Удаляет единственный экземпляр указанного элемента из этой очереди, если он присутствует. |
boolean |
removeAll |
Удаляет все элементы этой коллекции, которые также содержатся в указанной коллекции (необязательная операция). |
boolean |
removeIf |
Удаляет все элементы этой коллекции, удовлетворяющие заданному предикату. |
boolean |
retainAll |
Оставляет только элементы в этой коллекции, которые содержатся в указанной коллекции (необязательная операция). |
int |
size() |
Возвращает количество элементов в этой коллекции. |
Spliterator<E> |
spliterator() |
Возвращает Spliterator по элементам в этой очереди. |
E |
take() |
Извлекает и удаляет голову этой очереди, ожидая, если необходимо, пока элемент не станет доступным. |
Object[] |
toArray() |
Возвращает массив, содержащий все элементы в этой очереди. |
<T> T[] |
toArray |
Возвращает массив, содержащий все элементы в этой очереди; тип времени выполнения возвращаемого массива — тип указанного массива. |
Методы, объявленные в классе java.util.AbstractQueue
addAll, element, remove
Методы, объявленные в классе java.util.AbstractCollection
containsAll, isEmpty, toString
Методы, объявленные в классе java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Методы, объявленные в интерфейсе java.util.Collection
addAll, containsAll, equals, hashCode, isEmpty, parallelStream, stream, toArray
Подробное описание конструкторов
PriorityBlockingQueue
public PriorityBlockingQueue()
PriorityBlockingQueue с исходной ёмкостью по умолчанию (11), которая упорядочивает свои элементы в соответствии с их естественным порядком.PriorityBlockingQueue
public PriorityBlockingQueue(int initialCapacity)
PriorityBlockingQueue с указанной исходной ёмкостью, которая упорядочивает свои элементы в соответствии с их естественным порядком.- Параметры:
-
initialCapacity- исходная ёмкость для этой очереди с приоритетами - Исключения:
-
IllegalArgumentException- еслиinitialCapacityменьше 1
PriorityBlockingQueue
public PriorityBlockingQueue(int initialCapacity, Comparator<? super E> comparator)
PriorityBlockingQueue с указанной исходной ёмкостью, которая упорядочивает свои элементы в соответствии с указанным компаратором.- Параметры:
-
initialCapacity- исходная ёмкость для этой очереди с приоритетами -
comparator- компаратор, который будет использоваться для упорядочивания этой очереди с приоритетами. Еслиnull, будет использоваться естественный порядок элементов. - Исключения:
-
IllegalArgumentException- еслиinitialCapacityменьше 1
PriorityBlockingQueue
public PriorityBlockingQueue(Collection<? extends E> c)
PriorityBlockingQueue, содержащую элементы в указанной коллекции. Если указанная коллекция является SortedSet или PriorityBlockingQueue, эта очередь с приоритетами будет упорядочена в соответствии с тем же порядком. В противном случае эта очередь с приоритетами будет упорядочена в соответствии с естественным порядком своих элементов.- Параметры:
-
c- коллекция, элементы которой должны быть помещены в эту очередь с приоритетами - Исключения:
-
ClassCastException- если элементы указанной коллекции нельзя сравнить друг с другом в соответствии с порядком очереди с приоритетами -
NullPointerException- если указанная коллекция или любой из её элементов имеют значение null
Подробное описание методов
add
public boolean add(E e)
- Унаследовано от:
-
addв интерфейсеBlockingQueue<E> - Унаследовано от:
-
addв интерфейсеCollection<E> - Унаследовано от:
-
addв интерфейсеQueue<E> - Переопределяет:
-
addв классеAbstractQueue<E> - Параметры:
-
e- добавляемый элемент - Возвращает:
-
true(как указано вCollection.add(E)) - Исключения:
-
ClassCastException- если указанный элемент нельзя сравнить с элементами, которые в данный момент находятся в очереди с приоритетами, в соответствии с порядком очереди с приоритетами -
NullPointerException- если указанный элемент имеет значение null
offer
public boolean offer(E e)
false.- Унаследовано от:
-
offerв интерфейсеBlockingQueue<E> - Унаследовано от:
-
offerв интерфейсеQueue<E> - Параметры:
-
e- добавляемый элемент - Возвращает:
-
true(как указано вQueue.offer(E)) - Исключения:
-
ClassCastException- если указанный элемент нельзя сравнить с элементами, которые в данный момент находятся в очереди с приоритетами, в соответствии с порядком очереди с приоритетами -
NullPointerException- если указанный элемент имеет значение null
put
public void put(E e)
- Унаследовано от:
-
putв интерфейсеBlockingQueue<E> - Параметры:
-
e- добавляемый элемент - Исключения:
-
ClassCastException- если указанный элемент нельзя сравнить с элементами, которые в данный момент находятся в очереди с приоритетами, в соответствии с порядком очереди с приоритетами -
NullPointerException- если указанный элемент имеет значение null
offer
public boolean offer(E e, long timeout, TimeUnit unit)
false.- Унаследовано от:
-
offerв интерфейсеBlockingQueue<E> - Параметры:
-
e- добавляемый элемент -
timeout- Этот параметр игнорируется, так как метод никогда не блокируется -
unit- Этот параметр игнорируется, так как метод никогда не блокируется - Возвращает:
-
true(как указано вBlockingQueue.offer) - Исключения:
-
ClassCastException- если указанный элемент нельзя сравнить с элементами, которые в данный момент находятся в очереди с приоритетами, в соответствии с порядком очереди с приоритетами -
NullPointerException- если указанный элемент имеет значение null
poll
public E poll()
Queuenull если эта очередь пуста.- Унаследовано от:
-
pollв интерфейсеQueue<E> - Возвращает:
- голову этой очереди или
nullесли эта очередь пуста
take
public E take() throws InterruptedException
BlockingQueue- Унаследовано от:
-
takeв интерфейсеBlockingQueue<E> - Возвращает:
- голову этой очереди
- Исключения:
-
InterruptedException- если произошла ошибка прерывания во время ожидания
poll
public E poll(long timeout, TimeUnit unit) throws InterruptedException
BlockingQueue- Унаследовано от:
-
pollв интерфейсеBlockingQueue<E> - Параметры:
-
timeout- время ожидания, прежде чем прекратить ожидание, в единицахunit -
unit-TimeUnit, определяющий, как интерпретировать параметрtimeout - Возвращает:
- голову этой очереди или
nullесли заданное время ожидания истекло, прежде чем элемент стал доступным - Исключения:
-
InterruptedException- если произошла ошибка прерывания во время ожидания
peek
public E peek()
Queuenull если эта очередь пуста.- Унаследовано от:
-
peekв интерфейсеQueue<E> - Возвращает:
- голову этой очереди или
nullесли эта очередь пуста
comparator
public Comparator<? super E> comparator()
null если эта очередь использует естественный порядок своих элементов.- Возвращает:
- компаратор, используемый для упорядочивания элементов в этой очереди, или
nullесли эта очередь использует естественный порядок элементов
size
public int size()
CollectionInteger.MAX_VALUE элементов, возвращает Integer.MAX_VALUE.- Унаследовано от:
-
sizeв интерфейсеCollection<E> - Возвращает:
- количество элементов в этой коллекции
remainingCapacity
public int remainingCapacity()
Integer.MAX_VALUE , так как очередь с приоритетами PriorityBlockingQueue не ограничена по ёмкости.- Унаследовано от:
-
remainingCapacityв интерфейсеBlockingQueue<E> - Возвращает:
-
Integer.MAX_VALUEвсегда
удалить
public boolean remove(Object o)
e такой, что o.equals(e), если эта очередь содержит один или несколько таких элементов. Возвращает true тогда и только тогда, когда эта очередь содержала указанный элемент (или, что эквивалентно, если эта очередь изменилась в результате вызова).- Указано в:
-
removeв интерфейсеBlockingQueue<E> - Указано в:
-
removeв интерфейсеCollection<E> - Переопределяет:
-
removeв классеAbstractCollection<E> - Параметры:
-
o- элемент, который нужно удалить из этой очереди, если он присутствует - Возвращает:
-
trueесли эта очередь изменилась в результате вызова
содержит
public boolean contains(Object o)
true если эта очередь содержит указанный элемент. Более формально, возвращает true тогда и только тогда, когда эта очередь содержит по крайней мере один элемент e такой, что o.equals(e). - Указано в:
-
containsв интерфейсеBlockingQueue<E> - Указано в:
-
containsв интерфейсеCollection<E> - Переопределяет:
-
containsв классеAbstractCollection<E> - Параметры:
-
o- объект, который нужно проверить на наличие в этой очереди - Возвращает:
-
trueесли эта очередь содержит указанный элемент
drainTo
public int drainTo(Collection<? super E> c)
BlockingQueuec, может привести к тому, что элементы будут находиться ни в одном, ни в другом, ни в обоих наборах, когда будет выброшено соответствующее исключение. Попытки опорожнить очередь в себя приводят к IllegalArgumentException. Кроме того, поведение этой операции не определено, если указанный набор модифицируется во время выполнения операции.- Указано в:
-
drainToв интерфейсеBlockingQueue<E> - Параметры:
-
c- набор, в который нужно перенести элементы - Возвращает:
- количество перенесённых элементов
- Исключение:
-
UnsupportedOperationException- если добавление элементов не поддерживается указанным набором -
ClassCastException- если класс элемента этой очереди препятствует его добавлению в указанный набор -
NullPointerException- если указанный набор равен null -
IllegalArgumentException- если указанный набор является этой очередью или некоторые свойства элемента этой очереди препятствуют его добавлению в указанный набор
drainTo
public int drainTo(Collection<? super E> c, int maxElements)
BlockingQueuec, может привести к тому, что элементы будут находиться ни в одном, ни в другом, ни в обоих наборах, когда будет выброшено соответствующее исключение. Попытки опорожнить очередь в себя приводят к IllegalArgumentException. Кроме того, поведение этой операции не определено, если указанный набор модифицируется во время выполнения операции.- Указано в:
-
drainToв интерфейсеBlockingQueue<E> - Параметры:
-
c- набор, в который нужно перенести элементы -
maxElements- максимальное количество элементов для переноса - Возвращает:
- количество перенесённых элементов
- Исключение:
-
UnsupportedOperationException- если добавление элементов не поддерживается указанным набором -
ClassCastException- если класс элемента этой очереди препятствует его добавлению в указанный набор -
NullPointerException- если указанный набор равен null -
IllegalArgumentException- если указанный набор является этой очередью или некоторые свойства элемента этой очереди препятствуют его добавлению в указанный набор
очистить
public void clear()
- Указано в:
-
clearв интерфейсеCollection<E> - Переопределяет:
-
clearв классеAbstractQueue<E>
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> - Параметры типа:
-
T- тип компонента массива, который должен содержать коллекцию - Параметры:
-
a- массив, в который должны быть помещены элементы очереди, если он достаточно велик; в противном случае для этой цели выделяется новый массив того же типа времени выполнения - Возвращает:
- массив, содержащий все элементы в этой очереди
- Исключение:
-
ArrayStoreException- если тип времени выполнения указанного массива не является надтипом типа времени выполнения каждого элемента в этой очереди -
NullPointerException- если указанный массив равен null
итератор
public Iterator<E> iterator()
Возвращаемый итератор является слабо согласованным.
- Указано в:
-
iteratorв интерфейсеCollection<E> - Указано в:
-
iteratorв интерфейсеIterable<E> - Указано в:
-
iteratorв классеAbstractCollection<E> - Возвращает:
- итератор по элементам в этой очереди
spliterator
public Spliterator<E> spliterator()
Spliterator над элементами в этой очереди. Spliterator не обходит элементы в определенном порядке (характеристика ORDERED не сообщается). Возвращаемый spliterator является слабо согласованным.
Spliterator сообщает Spliterator.SIZED и Spliterator.NONNULL.
- Указано в:
-
spliteratorв интерфейсеCollection<E> - Указано в:
-
spliteratorв интерфейсеIterable<E> - Примечание к реализации:
Spliteratorдополнительно сообщаетSpliterator.SUBSIZED.- Возвращает:
Spliteratorнад элементами в этой очереди- С:
- 1.8
removeIf
public boolean removeIf(Predicate<? super E> filter)
Collection- Указано в:
-
removeIfв интерфейсеCollection<E> - Параметры:
-
filter- предикат, который возвращаетtrueдля элементов, которые нужно удалить - Возвращает:
-
trueесли какие-либо элементы были удалены - Исключение:
-
NullPointerException- если указанный фильтр равен null
removeAll
public boolean removeAll(Collection<?> c)
AbstractCollection- Указано в:
-
removeAllв интерфейсеCollection<E> - Переопределяет:
-
removeAllв классеAbstractCollection<E> - Параметры:
-
c- набор, содержащий элементы, которые необходимо удалить из этого набора - Возвращает:
-
trueесли этот набор был изменён в результате вызова - Исключения:
-
NullPointerException- если этот набор содержит один или несколько нулевых элементов, а указанный набор не поддерживает нулевые элементы (дополнительное), или если указанный набор является нулевым - См. также:
retainAll
public boolean retainAll(Collection<?> c)
AbstractCollection- Указано в:
-
retainAllв интерфейсеCollection<E> - Переопределяет:
-
retainAllв классеAbstractCollection<E> - Параметры:
-
c- набор, содержащий элементы, которые необходимо сохранить в этом наборе - Возвращает:
-
trueесли этот набор был изменён в результате вызова - Исключения:
-
NullPointerException- если этот набор содержит один или несколько нулевых элементов, а указанный набор не допускает нулевых элементов (дополнительное), или если указанный набор является нулевым - См. также:
forEach
public void forEach(Consumer<? super E> action)
IterableIterable, пока все элементы не будут обработаны или действие не выбросит исключение. Действия выполняются в порядке итерации, если этот порядок указан. Исключения, сгенерированные действием, передаются вызывающей стороне. Поведение этого метода не определено, если действие выполняет побочные эффекты, изменяющие базовый источник элементов, если только переопределяющий класс не указал политику одновременного изменения.
- Указано в:
-
forEachв интерфейсеIterable<E> - Параметры:
-
action- действие, которое должно быть выполнено для каждого элемента - Исключения:
-
NullPointerException- если указанное действие равно null
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/PriorityBlockingQueue.html