compact1, compact2, compact3

java.util.concurrent

Class DelayQueue<E extends Delayed>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

java.util.concurrent.DelayQueue<E>

参数类型

E - 在这个集合中保存的元素的类型

All Implemented Interfaces:

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)方法返回小于或等于零的值时，就会发生getDelay(TimeUnit.NANOSECONDS) 。 即使未使用的元素不能使用take或poll ，它们另外被视为普通元素。 例如， size方法返回到期和未到期元素的计数。 此队列不允许空元素。

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

这个类是Java Collections Framework的成员。

从以下版本开始：

1.5

构造方法摘要

构造方法

Constructor and Description
DelayQueue() 创建一个最初为空的新的 DelayQueue 。
DelayQueue(Collection<? extends E> c) 创建DelayQueue最初包含的给定集合中的元素Delayed个实例。

方法摘要

Modifier and Type	Method and Description
boolean	add(E e) 将指定的元素插入到此延迟队列中。
void	clear() 从此延迟队列中原子地删除所有元素。
int	drainTo(Collection<? super E> c) 从该队列中删除所有可用的元素，并将它们添加到给定的集合中。
int	drainTo(Collection<? super E> c, int maxElements) 最多从该队列中删除给定数量的可用元素，并将它们添加到给定的集合中。
Iterator<E>	iterator() 返回此队列中所有元素（已过期和未过期）的迭代器。
boolean	offer(E e) 将指定的元素插入到此延迟队列中。
boolean	offer(E e, long timeout, TimeUnit unit) 将指定的元素插入到此延迟队列中。
E	peek() 检索但不删除此队列的头，如果此队列为空，则返回 null 。
E	poll() 检索并删除此队列的头，或者如果此队列没有已过期延迟的元素，则返回 null 。
E	poll(long timeout, TimeUnit unit) 检索并删除此队列的头部，如果需要，等待具有到期延迟的元素可用于此队列，或指定的等待时间到期。
void	put(E e) 将指定的元素插入到此延迟队列中。
int	remainingCapacity() 总是返回 Integer.MAX_VALUE ，因为 DelayQueue没有容量限制。
boolean	remove(Object o) 从该队列中删除指定元素的单个实例（如果存在），无论其是否已过期。
int	size() 返回此集合中的元素数。
E	take() 检索并删除此队列的头部，如果需要，等待有一个延迟到期的元素在此队列上可用。
Object[]	toArray() 返回一个包含此队列中所有元素的数组。
<T> T[]	toArray(T[] a) 返回一个包含此队列中所有元素的数组; 返回的数组的运行时类型是指定数组的运行时类型。

Methods inherited from class java.util.AbstractQueue

addAll, element, remove

Methods inherited from class java.util.AbstractCollection

contains, 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.concurrent.BlockingQueue

contains

Methods inherited from interface java.util.Queue

element, remove

Methods inherited from interface java.util.Collection

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

Methods inherited from interface java.lang.Iterable

forEach

构造方法详细信息

DelayQueue

public DelayQueue()

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

DelayQueue

public DelayQueue(Collection<? extends E> c)

创建DelayQueue最初包含的给定集合中的元素Delayed个实例。

参数

c - 最初包含的元素的集合

异常

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

方法详细信息

add

public boolean add(E e)

将指定的元素插入到此延迟队列中。

Specified by:

add在接口 Collection<E extends Delayed>

Specified by:

add在接口 BlockingQueue<E extends Delayed>

Specified by:

add在界面 Queue<E extends Delayed>

重写：

add在 AbstractQueue<E extends Delayed>

参数

e - 要添加的元素

结果

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

异常

NullPointerException - 如果指定的元素为空

offer

public boolean offer(E e)

将指定的元素插入到此延迟队列中。

Specified by:

offer在接口 BlockingQueue<E extends Delayed>

Specified by:

offer在接口 Queue<E extends Delayed>

参数

e - 要添加的元素

结果

true

异常

NullPointerException - 如果指定的元素为空

put

public void put(E e)

将指定的元素插入到此延迟队列中。 队列是无限制的，这个方法永远不会被阻塞。

Specified by:

put中的 BlockingQueue<E extends Delayed>

参数

e - 要添加的元素

异常

NullPointerException - 如果指定的元素为空

offer

public boolean offer(E e,
                     long timeout,
                     TimeUnit unit)

将指定的元素插入到此延迟队列中。 队列是无限制的，这个方法永远不会被阻塞。

Specified by:

offer在接口 BlockingQueue<E extends Delayed>

参数

e - 要添加的元素

timeout - 该参数被忽略，因为该方法从不阻止

unit - 该参数被忽略，因为该方法从不阻止

结果

true

异常

NullPointerException - 如果指定的元素为空

poll

public E poll()

检索并删除此队列的头部，如果此队列没有延迟到期的元素，则返回 null 。

Specified by:

poll在接口 Queue<E extends Delayed>

结果

这个队列的头部，或 null如果这个队列没有到期的延迟的元素

take

public E take()
       throws InterruptedException

检索并删除此队列的头部，如果需要，等待有一个延迟到期的元素在此队列上可用。

Specified by:

take在接口 BlockingQueue<E extends Delayed>

结果

这个队列的头

异常

InterruptedException - 如果在等待时中断

poll

public E poll(long timeout,
              TimeUnit unit)
       throws InterruptedException

检索并删除此队列的头部，如果需要，等待具有到期延迟的元素可用于此队列，或指定的等待时间到期。

Specified by:

poll在界面 BlockingQueue<E extends Delayed>

参数

timeout - 放弃之前等待多久，以 unit为单位

unit - a TimeUnit确定如何解释 timeout参数

结果

这个队列的头部，或 null如果到期延迟了指定的等待时间的元素之前流逝变得可用

异常

InterruptedException - 如果中断等待

peek

public E peek()

检索但不删除此队列的头，如果此队列为空，则返回null 。 与poll不同，如果队列中没有过期的元素可用，则此方法返回将在以后过期的元素（如果存在）。

Specified by:

peek在接口 Queue<E extends Delayed>

结果

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

size

public int size()

描述从接口： Collection复制

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

Specified by:

size在接口 Collection<E extends Delayed>

Specified by:

size在 AbstractCollection<E extends Delayed>

结果

此集合中的元素数

drainTo

public int drainTo(Collection<? super E> c)

从接口复制： BlockingQueue

从该队列中删除所有可用的元素，并将它们添加到给定的集合中。 此操作可能比重复轮询此队列更有效。 尝试向集合c添加元素时遇到的c可能会导致元素在抛出关联的异常时既不在两个集合中，也可能不是两个集合。 尝试将队列排入自身导致IllegalArgumentException 。 此外，如果在操作进行中修改了指定的集合，则此操作的行为是未定义的。

Specified by:

drainTo在界面 BlockingQueue<E extends Delayed>

参数

c - 将元素传输到的集合

结果

转移的元素数量

异常

UnsupportedOperationException - 如果指定集合不支持元素的添加

ClassCastException - 如果此队列的元素的类阻止将其添加到指定的集合

NullPointerException - 如果指定的集合为空

IllegalArgumentException - 如果指定的集合是此队列，或该队列的某个元素的某些属性阻止将其添加到指定的集合

drainTo

public int drainTo(Collection<? super E> c,
                   int maxElements)

说明从界面： BlockingQueue复制

最多从该队列中删除给定数量的可用元素，并将它们添加到给定的集合中。 尝试向集合c添加元素时遇到的c可能导致元素在抛出关联的异常时都不在两个集合中。 尝试将队列排入自身导致IllegalArgumentException 。 此外，如果在操作进行中修改了指定的集合，则此操作的行为是未定义的。

Specified by:

drainTo在接口 BlockingQueue<E extends Delayed>

参数

c - 传输元素的集合

maxElements - 要传输的元素的最大数量

结果

转移的元素数量

异常

UnsupportedOperationException - 如果指定集合不支持元素的添加

ClassCastException - 如果此队列的元素的类阻止将其添加到指定的集合

NullPointerException - 如果指定的集合为空

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

remove

public boolean remove(Object o)

从该队列中删除指定元素的单个实例（如果存在），无论其是否已过期。

Specified by:

remove在接口 Collection<E extends Delayed>

Specified by:

remove在接口 BlockingQueue<E extends Delayed>

重写：

remove在类 AbstractCollection<E extends Delayed>

参数

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

结果

true如果一个元素被删除作为这个调用的结果

iterator

public Iterator<E> iterator()

返回此队列中所有元素（已过期和未过期）的迭代器。 迭代器不以任何特定顺序返回元素。

返回的迭代器是weakly consistent 。

Specified by:

iterator在接口 Iterable<E extends Delayed>

Specified by:

iterator在界面 Collection<E extends Delayed>

Specified by:

iterator在 AbstractCollection<E extends Delayed>

结果

an iterator over the elements in this queue