Spec-Zone.ru › OpenJDK 25

Класс PriorityQueue<E>

java.lang.Object
java.util.AbstractCollection<E>
java.util.AbstractQueue<E>
java.util.PriorityQueue<E>
Параметры типа:
E — тип элементов, хранящихся в этой очереди
Все реализуемые интерфейсы:
Serializable, Iterable<E>, Collection<E>, Queue<E>
public class PriorityQueue<E> extends AbstractQueue<E> implements Serializable
Неограниченная очередь queue с приоритетами, основанная на двоичной куче. Элементы очереди с приоритетами упорядочиваются согласно их естественному порядку либо с помощью Comparator, предоставленного при создании очереди, в зависимости от используемого конструктора. Очередь с приоритетами не допускает null. Очередь с приоритетами, использующая естественный порядок, также не допускает вставки объектов, не реализующих сравнение (это может привести к ClassCastException).

Голова этой очереди — наименьший элемент согласно заданному порядку. Если несколько элементов имеют наименьшее значение, головой становится один из них — выбор при равенстве значений производится произвольно. Операции извлечения из очереди poll, remove, peek и element обращаются к элементу в голове очереди.

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

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

Обратите внимание: эта реализация не является синхронизированной. Несколько потоков не должны одновременно обращаться к экземпляру PriorityQueue, если хотя бы один из потоков изменяет очередь. Вместо этого используйте потокобезопасный класс PriorityBlockingQueue.

Примечание по реализации: эта реализация обеспечивает время O(log(n)) для операций добавления и извлечения из очереди (offer, poll, remove() и add); линейное время для методов remove(Object) и contains(Object); и постоянное время для методов получения (peek, element и size).

Этот класс является частью фреймворка коллекций Java.

Начиная с версии:
1.5
См. также:
  • Сериализованная форма

Краткое описание конструкторов

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

Краткое описание методов

Модификатор и тип Метод Описание
boolean add(E e)
Вставляет указанный элемент в эту очередь с приоритетами.
void clear()
Удаляет все элементы из этой очереди с приоритетами.
Comparator<? super E> comparator()
Возвращает компаратор, используемый для упорядочивания элементов этой очереди, или null, если элементы этой очереди упорядочены согласно их естественному порядку.
boolean contains(Object o)
Возвращает true, если эта очередь содержит указанный элемент.
void forEach(Consumer<? super E> action)
Выполняет заданное действие для каждого элемента Iterable, пока не будут обработаны все элементы или действие не вызовет исключение.
Iterator<E> iterator()
Возвращает итератор по элементам этой очереди.
boolean offer(E e)
Вставляет указанный элемент в эту очередь с приоритетами.
E peek()
Извлекает, но не удаляет голову этой очереди, или возвращает null, если очередь пуста.
E poll()
Извлекает и удаляет голову этой очереди или возвращает null, если очередь пуста.
boolean remove(Object o)
Удаляет один экземпляр указанного элемента из этой очереди, если он присутствует.
boolean removeAll(Collection<?> c)
Удаляет из этой коллекции все элементы, которые также содержатся в указанной коллекции (необязательная операция).
boolean removeIf(Predicate<? super E> filter)
Удаляет из этой коллекции все элементы, удовлетворяющие заданному предикату (необязательная операция).
boolean retainAll(Collection<?> c)
Оставляет в этой коллекции только элементы, содержащиеся в указанной коллекции (необязательная операция).
int size()
Возвращает количество элементов в этой коллекции.
final Spliterator<E> spliterator()
Создает привязываемый при первом обращении и быстро завершающийся с ошибкой Spliterator для обхода элементов этой очереди.
Object[] toArray()
Возвращает массив, содержащий все элементы этой очереди.
<T> T[] toArray(T[] a)
Возвращает массив, содержащий все элементы этой очереди; тип возвращаемого массива во время выполнения совпадает с типом указанного массива.

Методы, объявленные в классе AbstractQueue

addAll, element, remove

Методы, объявленные в классе AbstractCollection

containsAll, isEmpty, toString

Методы, объявленные в классе Object

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

Методы, объявленные в интерфейсе Collection

containsAll, equals, hashCode, isEmpty, parallelStream, stream, toArray

Подробное описание конструкторов

PriorityQueue

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

PriorityQueue

public PriorityQueue(int initialCapacity)
Создает PriorityQueue с указанной начальной емкостью, элементы которой упорядочены согласно их естественному порядку.
Параметры:
initialCapacity — начальная емкость этой очереди с приоритетами
Исключения:
IllegalArgumentException — если initialCapacity меньше 1

PriorityQueue

public PriorityQueue(Comparator<? super E> comparator)
Создает PriorityQueue с начальной емкостью по умолчанию, элементы которой упорядочены согласно указанному компаратору.
Параметры:
comparator — компаратор, который будет использоваться для упорядочения этой очереди с приоритетами. Если null, будет использоваться естественный порядок элементов.
Начиная с версии:
1.8

PriorityQueue

public PriorityQueue(int initialCapacity, Comparator<? super E> comparator)
Создает PriorityQueue с указанной начальной емкостью, элементы которой упорядочены согласно указанному компаратору.
Параметры:
initialCapacity — начальная емкость этой очереди с приоритетами
comparator — компаратор, который будет использоваться для упорядочения этой очереди с приоритетами. Если null, будет использоваться естественный порядок элементов.
Исключения:
IllegalArgumentException — если initialCapacity меньше 1

PriorityQueue

public PriorityQueue(Collection<? extends E> c)
Создает PriorityQueue, содержащую элементы указанной коллекции. Если указанная коллекция является экземпляром SortedSet или другой PriorityQueue, эта очередь с приоритетами будет упорядочена так же. В противном случае элементы этой очереди с приоритетами будут упорядочены согласно их естественному порядку.
Параметры:
c — коллекция, элементы которой помещаются в эту очередь с приоритетами
Исключения:
ClassCastException — если элементы указанной коллекции нельзя сравнить друг с другом в соответствии с порядком этой очереди с приоритетами
NullPointerException — если указанная коллекция или любой из ее элементов равны null

PriorityQueue

public PriorityQueue(PriorityQueue<? extends E> c)
Создает PriorityQueue, содержащую элементы указанной очереди с приоритетами. Эта очередь с приоритетами будет упорядочена так же, как и заданная очередь с приоритетами.
Параметры:
c — очередь с приоритетами, элементы которой помещаются в эту очередь с приоритетами
Исключения:
ClassCastException — если элементы c нельзя сравнить друг с другом в соответствии с порядком c
NullPointerException — если указанная очередь с приоритетами или любой из ее элементов равны null

PriorityQueue

public PriorityQueue(SortedSet<? extends E> c)
Создает PriorityQueue, содержащую элементы указанного отсортированного множества. Эта очередь с приоритетами будет упорядочена так же, как и заданное отсортированное множество.
Параметры:
c — отсортированное множество, элементы которого помещаются в эту очередь с приоритетами
Исключения:
ClassCastException — если элементы указанного отсортированного множества нельзя сравнить друг с другом в соответствии с порядком этого множества
NullPointerException — если указанное отсортированное множество или любой из его элементов равны null

Подробное описание методов

add

public boolean add(E e)
Вставляет указанный элемент в эту очередь с приоритетами.
Определено в:
add в интерфейсе Collection<E>
Определено в:
add в интерфейсе Queue<E>
Переопределяет:
add в классе AbstractQueue<E>
Параметры:
e — добавляемый элемент
Возвращает:
true (как указано в Collection.add(E))
Исключения:
ClassCastException — если указанный элемент нельзя сравнить с элементами, находящимися в этой очереди с приоритетами, в соответствии с ее порядком
NullPointerException — если указанный элемент равен null

offer

public boolean offer(E e)
Вставляет указанный элемент в эту очередь с приоритетами.
Определено в:
offer в интерфейсе Queue<E>
Параметры:
e — добавляемый элемент
Возвращает:
true (как указано в Queue.offer(E))
Исключения:
ClassCastException — если указанный элемент нельзя сравнить с элементами, находящимися в этой очереди с приоритетами, в соответствии с ее порядком
NullPointerException — если указанный элемент равен null

peek

public E peek()
Описание скопировано из интерфейса: Queue
Извлекает, но не удаляет начало этой очереди или возвращает null, если очередь пуста.
Определено в:
peek в интерфейсе Queue<E>
Возвращает:
начало этой очереди или null, если очередь пуста

remove

public boolean remove(Object o)
Удаляет один экземпляр указанного элемента из этой очереди, если он присутствует. Точнее, удаляет элемент e такой, что o.equals(e), если эта очередь содержит один или несколько таких элементов. Возвращает true тогда и только тогда, когда эта очередь содержала указанный элемент (или, что равнозначно, если эта очередь изменилась в результате вызова).
Определено в:
remove в интерфейсе Collection<E>
Переопределяет:
remove в классе AbstractCollection<E>
Параметры:
o — элемент, который следует удалить из этой очереди, если он присутствует
Возвращает:
true, если эта очередь изменилась в результате вызова

contains

public boolean contains(Object o)
Возвращает true, если эта очередь содержит указанный элемент. Точнее, возвращает true тогда и только тогда, когда эта очередь содержит хотя бы один элемент e такой, что o.equals(e).
Определено в:
contains в интерфейсе Collection<E>
Переопределяет:
contains в классе AbstractCollection<E>
Параметры:
o — объект, наличие которого в этой очереди проверяется
Возвращает:
true, если эта очередь содержит указанный элемент

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

iterator

public Iterator<E> iterator()
Возвращает итератор для элементов этой очереди. Итератор возвращает элементы в произвольном порядке.
Определено в:
iterator в интерфейсе Collection<E>
Определено в:
iterator в интерфейсе Iterable<E>
Определено в:
iterator в классе AbstractCollection<E>
Возвращает:
итератор для элементов этой очереди

size

public int size()
Описание скопировано из интерфейса: Collection
Возвращает количество элементов в этой коллекции. Если коллекция содержит больше Integer.MAX_VALUE элементов, возвращает Integer.MAX_VALUE.
Определено в:
size в интерфейсе Collection<E>
Возвращает:
количество элементов в этой коллекции

clear

public void clear()
Удаляет все элементы из этой очереди с приоритетами. После возврата из этого вызова очередь будет пуста.
Определено в:
clear в интерфейсе Collection<E>
Переопределяет:
clear в классе AbstractQueue<E>

poll

public E poll()
Описание скопировано из интерфейса: Queue
Извлекает и удаляет начало этой очереди или возвращает null, если очередь пуста.
Определено в:
poll в интерфейсе Queue<E>
Возвращает:
начало этой очереди или null, если очередь пуста

comparator

public Comparator<? super E> comparator()
Возвращает компаратор, используемый для упорядочения элементов этой очереди, или null, если очередь отсортирована согласно естественному порядку ее элементов.
Возвращает:
компаратор, используемый для упорядочения этой очереди, или null, если очередь отсортирована согласно естественному порядку ее элементов

spliterator

public final Spliterator<E> spliterator()
Создает поздно связываемый и быстро завершающийся с ошибкой Spliterator для элементов этой очереди. Сплитератор обходит элементы в произвольном порядке (признак ORDERED не указывается).

Spliterator сообщает о признаках Spliterator.SIZED, Spliterator.SUBSIZED и Spliterator.NONNULL. Переопределяющие реализации должны документировать указание дополнительных значений признаков.

Определено в:
spliterator в интерфейсе Collection<E>
Определено в:
spliterator в интерфейсе Iterable<E>
Возвращает:
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 — если эта коллекция содержит один или несколько элементов null, а указанная коллекция не поддерживает элементы null (необязательно), либо если указанная коллекция равна null
См. также:
  • AbstractCollection.remove(Object)
  • AbstractCollection.contains(Object)

retainAll

public boolean retainAll(Collection<?> c)
Описание скопировано из класса: AbstractCollection
Оставляет в этой коллекции только элементы, содержащиеся в указанной коллекции (необязательная операция). Иными словами, удаляет из этой коллекции все элементы, которые не содержатся в указанной коллекции.
Определено в:
retainAll в интерфейсе Collection<E>
Переопределяет:
retainAll в классе AbstractCollection<E>
Параметры:
c — коллекция, содержащая элементы, которые следует оставить в этой коллекции
Возвращает:
true, если эта коллекция изменилась в результате вызова
Исключения:
NullPointerException — если эта коллекция содержит один или несколько элементов null, а указанная коллекция не допускает элементы null (необязательно), либо если указанная коллекция равна null
См. также:
  • AbstractCollection.remove(Object)
  • AbstractCollection.contains(Object)

forEach

public void forEach(Consumer<? super E> action)
Описание скопировано из интерфейса: Iterable
Выполняет заданное действие для каждого элемента Iterable, пока не будут обработаны все элементы или действие не выбросит исключение. Действия выполняются в порядке итерации, если этот порядок определен. Исключения, выброшенные действием, передаются вызывающему коду.

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

Определено в:
forEach в интерфейсе Iterable<E>
Параметры:
action — действие, выполняемое для каждого элемента
Исключения:
NullPointerException — если указанное действие равно null

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее филиалов в США и других странах.
Авторское право © 1993, 2025, Oracle и/или ее филиалы, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, 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/25/docs/api/java.base/java/util/PriorityQueue.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API