compact1, compact2, compact3

java.util

Class PriorityQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

java.util.PriorityQueue<E>

参数类型

E - 此集合中保存的元素的类型

All Implemented Interfaces:

Serializable ， Iterable <E>， Collection <E>， Queue <E>

public class PriorityQueue<E>
extends AbstractQueue<E>
implements Serializable

基于优先级堆的无限优先级queue 。 优先级队列的元素根据它们的有序natural ordering ，或由一个Comparator在队列构造的时候提供，这取决于所使用的构造方法。 优先队列不允许null元素。 依靠自然排序的优先级队列也不允许插入不可比较的对象（这样做可能导致ClassCastException ）。

该队列的头部是相对于指定顺序的最小元素。 如果多个元素被绑定到最小值，那么头就是这些元素之一 - 关系被任意破坏。 队列检索操作poll ， remove ， peek和element访问在队列的头部的元件。

优先级队列是无限制的，但是具有管理用于在队列上存储元素的数组的大小的内部容量 。 它始终至少与队列大小一样大。 当元素被添加到优先级队列中时，其容量会自动增长。 没有规定增长政策的细节。

该类及其迭代器实现Collection和Iterator接口的所有可选方法。 方法iterator()中提供的迭代器不能保证以任何特定顺序遍历优先级队列的元素。 如果需要有序遍历，请考虑使用Arrays.sort(pq.toArray()) 。

请注意，此实现不同步。 如果任何线程修改队列，多线程不应同时访问PriorityQueue实例。 而是使用线程安全的PriorityBlockingQueue类。

实现注意事项：此实现提供了O（日志（n））的时间入队和出队方法（ offer ， poll ， remove()和add ）; remove(Object)和contains(Object)方法的线性时间; 和恒定时间检索方法（ peek ， element和size ）。

这个班是Java Collections Framework的会员 。

从以下版本开始：

1.5

另请参见：

Serialized Form

构造方法摘要

构造方法

Constructor and Description
PriorityQueue() 创建一个PriorityQueue ，具有默认的初始容量（11），根据它们的natural ordering对其元素进行排序 。
PriorityQueue(Collection<? extends E> c) 创建一个 PriorityQueue集合中的元素的PriorityQueue。
PriorityQueue(Comparator<? super E> comparator) 创建具有默认初始容量的 PriorityQueue ，并根据指定的比较器对其元素进行排序。
PriorityQueue(int initialCapacity) 创建PriorityQueue与根据它们的排序其元素指定的初始容量natural ordering 。
PriorityQueue(int initialCapacity, Comparator<? super E> comparator) 创建具有 PriorityQueue初始容量的PriorityQueue，根据指定的比较器对其元素进行排序。
PriorityQueue(PriorityQueue<? extends E> c) 创建包含 PriorityQueue优先级队列中的元素的PriorityQueue。
PriorityQueue(SortedSet<? extends E> c) 创建一个 PriorityQueue指定排序集中的元素的PriorityQueue。

方法摘要

Modifier and Type	Method and Description
boolean	add(E e) 将指定的元素插入到此优先级队列中。
void	clear() 从此优先级队列中删除所有元素。
Comparator<? super E>	comparator() 返回用于为了在这个队列中的元素，或比较null如果此队列根据所述排序natural ordering的元素。
boolean	contains(Object o) 如果此队列包含指定的元素，则返回 true 。
Iterator<E>	iterator() 返回此队列中的元素的迭代器。
boolean	offer(E e) 将指定的元素插入到此优先级队列中。
E	peek() 检索但不删除此队列的头，如果此队列为空，则返回 null 。
E	poll() 检索并删除此队列的头，如果此队列为空，则返回 null 。
boolean	remove(Object o) 从该队列中删除指定元素的单个实例（如果存在）。
int	size() 返回此集合中的元素数。
Spliterator<E>	spliterator() 在此队列中的元素上创建late-binding和失败快速 Spliterator 。
Object[]	toArray() 返回一个包含此队列中所有元素的数组。
<T> T[]	toArray(T[] a) 返回一个包含此队列中所有元素的数组; 返回的数组的运行时类型是指定数组的运行时类型。

Methods inherited from class java.util.AbstractQueue

addAll, element, remove

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, stream

Methods inherited from interface java.lang.Iterable

forEach

构造方法详细信息

PriorityQueue

public PriorityQueue()

创建一个PriorityQueue ，具有默认的初始容量（11），根据它们的natural ordering对其元素进行排序 。

PriorityQueue

public PriorityQueue(int initialCapacity)

创建具有PriorityQueue初始容量的PriorityQueue，根据其natural ordering对其元素进行排序 。

参数

initialCapacity - 此优先级队列的初始容量

异常

IllegalArgumentException - 如果 initialCapacity小于1

PriorityQueue

public PriorityQueue(Comparator<? super E> comparator)

创建具有默认初始容量的 PriorityQueue ，并根据指定的比较器对其元素进行排序。

参数

comparator - 将用于订购此优先级队列的比较器。 如果null ，该natural ordering的元素将被使用。

从以下版本开始：

1.8

PriorityQueue

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

创建具有 PriorityQueue初始容量的PriorityQueue，根据指定的比较器对其元素进行排序。

参数

initialCapacity - 此优先级队列的初始容量

comparator - 将用于订购此优先级队列的比较器。 如果null ，将使用natural ordering的元素。

异常

IllegalArgumentException - 如果 initialCapacity小于1

PriorityQueue

public PriorityQueue(Collection<? extends E> c)

创建一个PriorityQueue集合中的元素的PriorityQueue。 如果指定的集合是一个实例SortedSet或者是另一种PriorityQueue ，这个优先级队列将按照相同的顺序进行排序。 否则，此优先级队列将根据其元素的natural ordering进行排序。

参数

c - 要将元素放入此优先级队列的集合

异常

ClassCastException - 如果指定集合的元素不能根据优先级队列的顺序相互比较

NullPointerException - 如果指定的集合或其任何元素为空

PriorityQueue

public PriorityQueue(PriorityQueue<? extends E> c)

创建一个PriorityQueue指定优先级队列中的元素的PriorityQueue。 该优先级队列将按照与给定优先级队列相同的顺序进行排序。

参数

c - 其元素要放入此优先级队列的优先级队列

异常

ClassCastException -如果元素 c不能相互比较根据 c的订货

NullPointerException - 如果指定的优先级队列或其任何元素为空

PriorityQueue

public PriorityQueue(SortedSet<? extends E> c)

创建一个PriorityQueue指定排序集中的元素的PriorityQueue。 该优先级队列将按照与给定排序集相同的顺序进行排序。

参数

c - c元素放入此优先级队列的排序集

异常

ClassCastException - 如果指定的排序集的元素不能根据排序集的排序相互比较

NullPointerException - 如果指定的排序集或其任何元素为空

方法详细信息

add

public boolean add(E e)

将指定的元素插入到此优先级队列中。

Specified by:

add在界面 Collection<E>

Specified by:

add在界面 Queue<E>

重写：

add在类别 AbstractQueue<E>

参数

e - 要添加的元素

结果

true （由 Collection.add(E)指定 ）

异常

ClassCastException - 如果指定的元素不能与当前在此优先级队列中的元素根据优先级队列的排序进行比较

NullPointerException - 如果指定的元素为空

offer

public boolean offer(E e)

将指定的元素插入到此优先级队列中。

Specified by:

offer在界面 Queue<E>

参数

e - 要添加的元素

结果

true （由 Queue.offer(E)指定 ）

异常

ClassCastException - 如果指定的元素不能与当前在此优先级队列中的元素根据优先级队列的排序进行比较

NullPointerException - 如果指定的元素为空

peek

public E peek()

说明从界面： Queue复制

检索但不删除此队列的头部，如果此队列为空，则返回 null 。

Specified by:

peek在界面 Queue<E>

结果

该队列的头，或 null如果这个队列是空的

remove

public boolean remove(Object o)

从该队列中删除指定元素的单个实例（如果存在）。 更正式地，删除一个元素e ，使得o.equals(e) ，如果这个队列包含一个或多个这样的元素。 返回true当且仅当此队列包含指定的元素（或等效地，如果此队列作为调用的结果而更改）。

Specified by:

remove在界面 Collection<E>

重写：

remove在类别 AbstractCollection<E>

参数

o - 要从此队列中删除的元素（如果存在）

结果

true如果此队列由于调用而更改

contains

public boolean contains(Object o)

如果此队列包含指定的元素，则返回true 。 更正式地，返回true当且仅当该队列至少包含一个元素e ，使得o.equals(e) 。

Specified by:

contains在界面 Collection<E>

重写：

contains在类别 AbstractCollection<E>

参数

o - 要检查此队列中的遏制的对象

结果

true如果此队列包含指定的元素

toArray

public Object[] toArray()

返回一个包含此队列中所有元素的数组。 元素没有特定的顺序。

返回的数组将是“安全的”，因为该队列不保留对它的引用。 （换句话说，这个方法必须分配一个新的数组）。 因此，调用者可以自由地修改返回的数组。

此方法充当基于阵列和基于集合的API之间的桥梁。

Specified by:

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

Specified by:

toArray在界面 Collection<E>

重写：

toArray在 AbstractCollection<E>

参数类型

T - 包含集合的数组的运行时类型

参数

a - 要存储队列的元素的阵列，如果它足够大; 否则，为此目的分配相同运行时类型的新数组。

结果

一个包含此队列中所有元素的数组

异常

ArrayStoreException - 如果指定数组的运行时类型不是此队列中每个元素的运行时类型的超类型

NullPointerException - 如果指定的数组为空

iterator

public Iterator<E> iterator()

返回此队列中的元素的迭代器。 迭代器不以任何特定顺序返回元素。

Specified by:

iterator在界面 Iterable<E>

Specified by:

iterator在界面 Collection<E>

Specified by:

iterator在 AbstractCollection<E>

结果

这个队列中的元素的迭代器

size

public int size()

说明从界面： Collection复制

返回此集合中的元素数。 如果此集合包含超过Integer.MAX_VALUE个元素，则返回Integer.MAX_VALUE 。

Specified by:

size在接口 Collection<E>

Specified by:

size在类别 AbstractCollection<E>

结果

此集合中的元素数

clear

public void clear()

从此优先级队列中删除所有元素。 此呼叫返回后队列将为空。

Specified by:

clear在界面 Collection<E>

重写：

clear在类别 AbstractQueue<E>

poll

public E poll()

说明从界面： Queue复制

检索并删除此队列的头，如果此队列为空，则返回 null 。

Specified by:

poll在界面 Queue<E>

结果

这个队列的头，或 null如果这个队列是空的

comparator

public Comparator<? super E> comparator()

返回用于排序此队列中的元素的比较器，或null如果此队列根据其元素的natural ordering进行排序。

结果

比较器用于排序此队列，或 null如果此队列根据其元素的自然排序进行排序

spliterator

public final Spliterator<E> spliterator()

在此队列中的元素上创建late-binding和失败快速 Spliterator 。

该Spliterator报告Spliterator.SIZED ， Spliterator.SUBSIZED和Spliterator.NONNULL 。 覆盖实现应记录其他特征值的报告。

Specified by:

spliterator在界面 Iterable<E>

Specified by:

spliterator在界面 Collection<E>

结果

一个 Spliterator在这个队列中的元素

从以下版本开始：

1.8