- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractQueue<E>
-
- java.util.concurrent.DelayQueue<E>
-
- 参数类型
-
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()
创建一个最初为空的新DelayQueue
。DelayQueue(Collection<? extends E> c)
创建DelayQueue
最初包含的给定集合中的元素Delayed
个实例。
-
方法摘要
所有方法 实例方法 具体的方法 变量和类型 方法 描述 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)
从此队列中删除指定元素的单个实例(如果存在),无论它是否已过期。E
take()
检索并删除此队列的头部,必要时等待,直到此队列上有一个具有过期延迟的元素。Object[]
toArray()
返回包含此队列中所有元素的数组。<T> T[]
toArray(T[] a)
返回包含此队列中所有元素的数组; 返回数组的运行时类型是指定数组的运行时类型。-
声明方法的类 java.util.AbstractQueue
addAll, element, remove
-
声明方法的类 java.util.AbstractCollection
contains, containsAll, isEmpty, removeAll, retainAll, toString
-
声明方法的类 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
声明方法的接口 java.util.concurrent.BlockingQueue
contains
-
声明方法的接口 java.util.Collection
addAll, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, size, spliterator, stream, toArray
-
-
-
-
构造方法详细信息
-
DelayQueue
public DelayQueue()
创建一个最初为空的新DelayQueue
。
-
DelayQueue
public DelayQueue(Collection<? extends E> c)
创建DelayQueue
最初包含的给定集合中的元素Delayed
个实例。- 参数
-
c
- 最初包含的元素集合 - 异常
-
NullPointerException
- 如果指定的集合或其任何元素为null
-
-
方法详细信息
-
add
public boolean add(E e)
将指定的元素插入此延迟队列。- Specified by:
-
add
在界面BlockingQueue<E extends Delayed>
- Specified by:
-
add
在界面Collection<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
。
-
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
不同,如果队列中没有可用的过期元素,则此方法返回下一个将过期的元素(如果存在)。
-
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
-
remove
public boolean remove(Object o)
从此队列中删除指定元素的单个实例(如果存在),无论它是否已过期。- Specified by:
-
remove
在界面BlockingQueue<E extends Delayed>
- Specified by:
-
remove
在界面Collection<E extends Delayed>
- 重写:
-
remove
类AbstractCollection<E extends Delayed>
- 参数
-
o
- 要从此集合中删除的元素(如果存在) - 结果
-
true
如果由于此调用而删除了某个元素
-
-