模块  java.base
软件包  java.util.concurrent

Class PriorityBlockingQueue<E>

  • 参数类型
    E - 此队列中保留的元素类型
    实现的所有接口
    Serializable ， Iterable<E> ， Collection<E> ， BlockingQueue<E> ， Queue<E> 
    public class PriorityBlockingQueue<E>extends AbstractQueue<E>implements BlockingQueue<E>, Serializable
    无界blocking queue ，它使用与类PriorityQueue相同的排序规则，并提供阻塞检索操作。 虽然此队列在逻辑上是无限制的，但由于资源耗尽（ OutOfMemoryError ），尝试添加可能会失败。 本课程不允许使用null元素。 依赖于natural ordering的优先级队列也不允许插入不可比较的对象（这样做会导致ClassCastException ）。

    该类及其迭代器实现了Collection和Iterator接口的所有可选方法。 方法iterator()中提供的迭代器和方法spliterator()中提供的Spliterator 不保证以任何特定顺序遍历PriorityBlockingQueue的元素。 如果您需要有序遍历，请考虑使用Arrays.sort(pq.toArray()) 。 此外，方法drainTo可用于按优先级顺序移除一些或所有元素并将它们放置在另一个集合中。

    此类的操作不保证具有相同优先级的元素的排序。 如果需要强制执行排序，则可以定义使用辅助键来断开主要优先级值中的关系的自定义类或比较器。 例如，这是一个将先进先出的打破平局应用于可比元素的类。 要使用它，您将插入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 Collections Framework的成员。

    从以下版本开始：
    1.5
    另请参见：
    Serialized Form

    • 构造方法详细信息

      • PriorityBlockingQueue

        public PriorityBlockingQueue()
        使用默认初始容量（11）创建PriorityBlockingQueue ，根据其natural ordering对其元素进行排序 。

      • PriorityBlockingQueue

        public PriorityBlockingQueue​(int initialCapacity)
        创建具有指定初始容量的PriorityBlockingQueue ，该容量根据其natural ordering对其元素进行排序 。
        参数
        initialCapacity - 此优先级队列的初始容量
        异常
        IllegalArgumentException - 如果 initialCapacity小于1

      • PriorityBlockingQueue

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

      • PriorityBlockingQueue

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

    • 方法详细信息

      • offer

        public boolean offer​(E e)
        将指定的元素插入此优先级队列。 由于队列无限制，此方法永远不会返回false 。
        Specified by:
        offer在界面 BlockingQueue<E>
        Specified by:
        offer在界面 Queue<E>
        参数
        e - 要添加的元素
        结果
        true （由 Queue.offer(E)指定）
        异常
        ClassCastException - 如果根据优先级队列的顺序无法将指定的元素与当前在优先级队列中的元素进行比较
        NullPointerException - 如果指定的元素为null

      • put

        public void put​(E e)
        将指定的元素插入此优先级队列。 由于队列是无限制的，因此该方法永远不会阻塞。
        Specified by:
        put在界面 BlockingQueue<E>
        参数
        e - 要添加的元素
        异常
        ClassCastException - 如果根据优先级队列的顺序无法将指定的元素与当前在优先级队列中的元素进行比较
        NullPointerException - 如果指定的元素为null

      • offer

        public boolean offer​(E e,                     long timeout,                     TimeUnit unit)
        将指定的元素插入此优先级队列。 由于队列无限制，此方法永远不会阻止或返回false 。
        Specified by:
        offer在界面 BlockingQueue<E>
        参数
        e - 要添加的元素
        timeout - 忽略此参数，因为方法永不阻塞
        unit - 忽略此参数，因为方法永不阻塞
        结果
        true （由 BlockingQueue.offer指定）
        异常
        ClassCastException - 如果根据优先级队列的顺序无法将指定的元素与当前在优先级队列中的元素进行比较
        NullPointerException - 如果指定的元素为null

      • comparator

        public Comparator<? super E> comparator()
        返回用于为了在这个队列中的元素，或比较null如果此队列使用natural ordering的元素。
        结果
        用于对此队列中的元素进行排序的比较器，如果此队列使用其元素的自然顺序， null

      • remainingCapacity

        public int remainingCapacity()
        始终返回 Integer.MAX_VALUE因为 PriorityBlockingQueue不受容量限制。
        Specified by:
        remainingCapacity在界面 BlockingQueue<E>
        结果
        总是 Integer.MAX_VALUE

      • remove

        public boolean remove​(Object o)
        从此队列中删除指定元素的单个实例（如果存在）。 更正式地，如果此队列包含一个或多个这样的元素，则移除元素e ，使得o.equals(e) 。 当且仅当此队列包含指定元素时（或等效地，如果此队列因调用而更改），则返回true 。
        Specified by:
        remove ，界面 BlockingQueue<E>
        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 ，界面 BlockingQueue<E>
        Specified by:
        contains在界面 Collection<E>
        重写：
        contains在课程 AbstractCollection<E>
        参数
        o - 要在此队列中检查包含的对象
        结果
        true如果此队列包含指定的元素

      • drainTo

        public int drainTo​(Collection<? super E> c)
        从界面复制的说明： BlockingQueue
        从此队列中删除所有可用元素，并将它们添加到给定集合中。 此操作可能比重复轮询此队列更有效。 尝试将元素添加到集合c遇到的故障可能导致在抛出关联的异常时元素既不在集合中，也不在集合中。 尝试将队列排入自身会导致IllegalArgumentException 。 此外，如果在操作正在进行时修改了指定的集合，则此操作的行为是不确定的。
        Specified by:
        drainTo ，界面 BlockingQueue<E>
        参数
        c - 将元素转换为的集合
        结果
        转移的元素数量
        异常
        UnsupportedOperationException - 如果指定集合不支持添加元素
        ClassCastException - 如果此队列的元素的类阻止将其添加到指定的集合中
        NullPointerException - 如果指定的集合为null
        IllegalArgumentException - 如果指定的集合是此队列，或此队列的某个元素的某些属性阻止将其添加到指定的集合

      • drainTo

        public int drainTo​(Collection<? super E> c,                   int maxElements)
        从界面复制的说明： BlockingQueue
        从该队列中删除最多给定数量的可用元素，并将它们添加到给定集合中。 尝试向集合c添加元素时遇到的故障可能导致在抛出关联的异常时元素既不在集合中，也不在集合中。 尝试将队列排入自身会导致IllegalArgumentException 。 此外，如果在操作正在进行时修改了指定的集合，则此操作的行为是不确定的。
        Specified by:
        drainTo在界面 BlockingQueue<E>
        参数
        c - 将元素转移到的集合
        maxElements - 要传输的最大元素数
        结果
        转移的元素数量
        异常
        UnsupportedOperationException - 如果指定集合不支持添加元素
        ClassCastException - 如果此队列的元素的类阻止将其添加到指定的集合中
        NullPointerException - 如果指定的集合为null
        IllegalArgumentException - 如果指定的集合是此队列，或者此队列的某个元素的某些属性阻止将其添加到指定的集合

      • clear

        public void clear()
        以原子方式删除此队列中的所有元素。 此调用返回后，队列将为空。
        Specified by:
        clear在界面 Collection<E>
        重写：
        clear类 AbstractQueue<E>

      • 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 - 如果指定的数组为null

      • removeIf

        public boolean removeIf​(Predicate<? super E> filter)
        从界面复制的说明： Collection
        删除此集合中满足给定谓词的所有元素。 在迭代期间或通过谓词抛出的错误或运行时异常被中继到调用者。
        Specified by:
        removeIf ，界面 Collection<E>
        参数
        filter - 一个谓词，它为要删除的元素返回 true
        结果
        true是否删除了任何元素
        异常
        NullPointerException - 如果指定的过滤器为null

      • forEach

        public void forEach​(Consumer<? super E> action)
        从界面复制的说明： Iterable
        对Iterable每个元素执行给定操作，直到处理Iterable所有元素或操作引发异常。 如果指定了该顺序，则按迭代顺序执行操作。 操作抛出的异常将转发给调用者。

        如果操作执行修改元素的基础源的副作用，则此方法的行为未指定，除非重写类已指定并发修改策略。

        Specified by:
        forEach在界面 Iterable<E>
        参数
        action - 要为每个元素执行的操作
        异常
        NullPointerException - 如果指定的操作为null