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 ， Collection ， BlockingQueue ， Queue

public class DelayQueue<E extends Delayed>
extends AbstractQueue<E>
implements BlockingQueue<E>

对 Delayed元素无界 blocking queue，其中一个元素只可以当其延迟已过期。队列的头部是 Delayed元的延迟过期遥远的过去。如果没有延迟已过期，没有头和 poll将返回 null。到期时发生的一个元素的 getDelay(TimeUnit.NANOSECONDS)方法返回的值小于或等于零。即使未到期的元素不能使用 take或 poll移除，他们否则视为正常的元素。例如，在 size方法返回的过期和未到期的元素计数。此队列不允许空元素。

这个类和它的迭代器实现所有的可选方法的Collection和Iterator接口。方法iterator()提供的迭代器不能保证导线的DelayQueue元素在任何特定的顺序。

这个班的一员 Java Collections Framework。

从以下版本开始：

一点五

构造方法摘要

构造方法

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

Constructor Detail

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 -如果指定元素为null

offer

public boolean offer(E e)

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

Specified by:

offer 接口 BlockingQueue<E extends Delayed>

Specified by:

offer 接口 Queue<E extends Delayed>

参数

e -元素添加

结果

true

异常

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如果队列中没有元素与过期的延迟

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 - 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添加元素可能会导致元素在没有遭遇过失败，或集合时相关的异常被抛出。试图排队列本身造成 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添加元素可能会导致元素在没有遭遇过失败，或集合时相关的异常被抛出。试图排队列本身造成 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()

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

返回的数组将是“安全”的，在这个队列中没有引用它的引用。（换句话说，这种方法必须分配一个新的数组）。因此，调用方可以自由修改返回的数组。

此方法作为基于数组和基于集合的原料药之间的桥梁。

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>

结果

在此队列中的元素的迭代器