Module  java.base
软件包  java.util

Class 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()中提供的迭代器和方法spliterator()中提供的分割器不能保证以任何特定顺序遍历优先级队列的元素。 如果需要排序遍历，请考虑使用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

    • 构造方法详细信息

      • PriorityQueue

        public PriorityQueue​()
        创建PriorityQueue与根据它们的排序其元素默认初始容量（11） natural ordering 。

      • PriorityQueue

        public PriorityQueue​(int initialCapacity)
        创建具有指定初始容量的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 ，该容量根据指定的比较器对其元素进行排序。
        参数
        initialCapacity - 此优先级队列的初始容量
        comparator - 将用于对此优先级队列进行排序的比较器。 如果是null ，将使用natural ordering的元素。
        异常
        IllegalArgumentException - 如果 initialCapacity小于1

      • PriorityQueue

        public PriorityQueue​(Collection<? extends E> c)
        创建包含指定集合中的元素的PriorityQueue 。 如果指定的集合是SortedSet的实例或另一个PriorityQueue ，则该优先级队列将按照相同的顺序排序。 否则，此优先级队列将根据其元素的natural ordering进行排序。
        参数
        c - c元素放入此优先级队列的集合
        异常
        ClassCastException - 如果指定集合的元素不能根据优先级队列的顺序相互比较
        NullPointerException - 如果指定的集合或其任何元素为空

      • PriorityQueue

        public PriorityQueue​(PriorityQueue<? extends E> c)
        创建包含指定优先级队列中的元素的PriorityQueue 。 该优先级队列将按照与给定优先级队列相同的顺序进行排序。
        参数
        c - 其元素要放入此优先级队列的优先级队列
        异常
        ClassCastException -如果元素 c不能相互比较根据 c的订货
        NullPointerException - 如果指定的优先级队列或其任何元素为空

      • PriorityQueue

        public PriorityQueue​(SortedSet<? extends E> c)
        创建包含指定排序集中的元素的PriorityQueue 。 该优先级队列将按照与给定排序集相同的顺序进行排序。
        参数
        c - c元素放入此优先级队列的排序集
        异常
        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 - 如果指定的数组为空

      • 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如果此队列根据其元素的自然排序进行排序