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

Class DelayQueue<E extends Delayed>

  • 参数类型
    E - 此队列中保留的元素类型
    实现的所有接口
    Iterable<E> ， Collection<E> ， BlockingQueue<E> ， Queue<E> 
    public class DelayQueue<E extends Delayed>extends AbstractQueue<E>implements BlockingQueue<E>
    无限制的blocking queue的Delayed元素，其中元素只能在其延迟到期时获取。 队列的头部是Delayed元素，其延迟在过去最远。 如果没有延迟到期，则没有头， poll将返回null 。 当元素的getDelay(TimeUnit.NANOSECONDS)方法返回小于或等于零的值时，会发生到期。 即使使用take或poll无法删除未到期的元素，它们也会被视为普通元素。 例如， size方法返回已过期和未过期元素的计数。 此队列不允许null元素。

    该类及其迭代器实现了Collection和Iterator接口的所有可选方法。 方法iterator()中提供的迭代器不保证以任何特定顺序遍历DelayQueue的元素。

    此类是Java Collections Framework的成员。

    从以下版本开始：
    1.5

    • 构造方法详细信息

      • DelayQueue

        public DelayQueue()
        创建一个最初为空的新 DelayQueue 。

      • DelayQueue

        public DelayQueue​(Collection<? extends E> c)
        创建DelayQueue最初包含的给定集合中的元素Delayed个实例。
        参数
        c - 最初包含的元素集合
        异常
        NullPointerException - 如果指定的集合或其任何元素为null

    • 方法详细信息

      • put

        public void put​(E e)
        将指定的元素插入此延迟队列。 由于队列是无限制的，因此该方法永远不会阻塞。
        Specified by:
        put在界面 BlockingQueue<E extends Delayed>
        参数
        e - 要添加的元素
        异常
        NullPointerException - 如果指定的元素为null

      • offer

        public boolean offer​(E e,                     long timeout,                     TimeUnit unit)
        将指定的元素插入此延迟队列。 由于队列是无限制的，因此该方法永远不会阻塞。
        Specified by:
        offer在界面 BlockingQueue<E extends Delayed>
        参数
        e - 要添加的元素
        timeout - 由于方法永不阻塞，因此忽略此参数
        unit - 忽略此参数，因为方法永不阻塞
        结果
        true
        异常
        NullPointerException - 如果指定的元素为null

      • poll

        public E poll()
        检索并删除此队列的头部，如果此队列没有具有过期延迟的元素，则返回 null 。
        Specified by:
        poll在界面 Queue<E extends Delayed>
        结果
        此队列的头部，或 null如果此队列没有具有过期延迟的元素

      • poll

        public E poll​(long timeout,              TimeUnit unit)       throws InterruptedException
        检索并删除此队列的头部，必要时等待，直到此队列上具有过期延迟的元素或指定的等待时间到期为止。
        Specified by:
        poll在界面 BlockingQueue<E extends Delayed>
        参数
        timeout - 放弃前等待多长时间，单位为 unit
        unit -一个 TimeUnit确定如何解释 timeout参数
        结果
        此队列的头部，或者如果在具有延迟过期的元素可用之前经过了指定的等待时间， null
        异常
        InterruptedException - 如果在等待时中断

      • peek

        public E peek()
        检索但不移除此队列的头部，如果此队列为空，则返回null 。 与poll不同，如果队列中没有可用的过期元素，则此方法返回下一个将过期的元素（如果存在）。
        Specified by:
        peek在界面 Queue<E extends Delayed>
        结果
        此队列的头部，如果此队列为空， null

      • drainTo

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

      • drainTo

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

      • clear

        public void clear()
        以原子方式从此延迟队列中删除所有元素。 此调用返回后，队列将为空。 没有等待延迟的元素; 它们只是从队列中丢弃。
        Specified by:
        clear在界面 Collection<E extends Delayed>
        重写：
        clear类 AbstractQueue<E extends Delayed>

      • remainingCapacity

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

      • toArray

        public Object[] toArray()
        返回包含此队列中所有元素的数组。 返回的数组元素没有特定的顺序。

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

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

        Specified by:
        toArray在界面 Collection<E extends Delayed>
        重写：
        toArray类 AbstractCollection<E extends Delayed>
        结果
        包含此队列中所有元素的数组

      • toArray

        public <T> T[] toArray​(T[] a)
        返回包含此队列中所有元素的数组; 返回数组的运行时类型是指定数组的运行时类型。 返回的数组元素没有特定的顺序。 如果队列适合指定的数组，则返回其中。 否则，将使用指定数组的运行时类型和此队列的大小分配新数组。

        如果此队列适合具有备用空间的指定数组（即，该数组具有比此队列多的元素），则紧跟在队列末尾之后的数组中的元素将设置为null 。

        与toArray()方法一样，此方法充当基于阵列和基于集合的API之间的桥梁。 此外，该方法允许精确控制输出阵列的运行时类型，并且在某些情况下可以用于节省分配成本。

        以下代码可用于将延迟队列转储到新分配的Delayed数组中： 

          Delayed[] a = q.toArray(new Delayed[0]);
        请注意， toArray(new Object[0])功能与toArray()相同。
        Specified by:
        toArray在界面 Collection<E extends Delayed>
        重写：
        toArray类 AbstractCollection<E extends Delayed>
        参数类型
        T - 要包含集合的数组的组件类型
        参数
        a - 要存储队列元素的数组（如果足够大）; 否则，为此目的分配相同运行时类型的新数组
        结果
        包含此队列中所有元素的数组
        异常
        ArrayStoreException - 如果指定数组的运行时类型不是此队列中每个元素的运行时类型的超类型
        NullPointerException - 如果指定的数组为null