Most visited

Recently visited

Results for

Added in API level 1

Summary: Ctors | Methods | Inherited Methods | [Expand All]

DelayQueue

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

java.lang.Object
↳	java.util.AbstractCollection<E extends java.util.concurrent.Delayed>
	↳	java.util.AbstractQueue<E extends java.util.concurrent.Delayed>
		↳	java.util.concurrent.DelayQueue<E extends java.util.concurrent.Delayed>

无界blocking queue的Delayed元件，其中，当其延迟已到期的元素只能采取。队列的头部是过去最远延迟过期的元素Delayed 。如果没有延迟已经过期，则没有头，并且poll将返回null 。当元素的getDelay(TimeUnit.NANOSECONDS)方法返回小于或等于零的值时，就会发生过期。即使未过期的元素不能使用take或poll删除，但它们在其他方面被视为正常元素。例如， size方法返回已过期和未过期元素的计数。该队列不允许空元素。

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

Summary

Public constructors
`DelayQueue()` 创建最初为空的新的 `DelayQueue` 。
`DelayQueue(Collection<? extends E> c)` 创建一个 `DelayQueue`最初包含给定的 `Delayed`实例集合的 `Delayed` 。

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

Inherited methods

From class java.util.AbstractQueue

From class java.util.AbstractCollection

`boolean`	`add(E e)` 确保此集合包含指定的元素（可选操作）。这个实现总是抛出一个 `UnsupportedOperationException` 。
`boolean`	`addAll(Collection<? extends E> c)` 将指定集合中的所有元素添加到此集合（可选操作）。该实现迭代指定的集合，并将迭代器返回的每个对象依次添加到该集合中。
`void`	`clear()` 从该集合中删除所有元素（可选操作）。此实现迭代该集合，使用 `Iterator.remove`操作删除每个元素。
`boolean`	`contains(Object o)` 如果此集合包含指定的元素，则返回 `true` 。该实现迭代集合中的元素，依次检查每个元素是否与指定元素相等。
`boolean`	`containsAll(Collection<?> c)` 如果此集合包含指定集合中的所有元素，则返回 `true` 。此实现迭代指定的集合，依次检查迭代器返回的每个元素，以查看它是否包含在此集合中。
`boolean`	`isEmpty()` 如果此集合不包含元素，则返回 `true` 。该实现返回 `size() == 0` 。
`abstract Iterator<E>`	`iterator()` 返回此集合中包含的元素的迭代器。
`boolean`	`remove(Object o)` 从该集合中移除指定元素的单个实例（如果存在）（可选操作）。该实现迭代查找指定元素的集合。
`boolean`	`removeAll(Collection<?> c)` 删除指定集合中包含的所有此集合的元素（可选操作）。该实现迭代该集合，依次检查迭代器返回的每个元素，以查看它是否包含在指定集合中。
`boolean`	`retainAll(Collection<?> c)` 仅保留包含在指定集合中的此集合中的元素（可选操作）。该实现迭代该集合，依次检查迭代器返回的每个元素，以查看它是否包含在指定集合中。
`abstract int`	`size()` 返回此集合中的元素数量。
`<T> T[]`	`toArray(T[] a)` 返回包含此集合中所有元素的数组; 返回数组的运行时类型是指定数组的运行时类型。该实现返回一个数组，其中包含由该集合的迭代器以相同顺序返回的所有元素，并存储在数组的连续元素中，从索引 `0`开始。
`Object[]`	`toArray()` 返回包含此集合中所有元素的数组。该实现以索引 `0`开始，以相同的顺序返回一个数组，其中包含由该集合的迭代器返回的所有元素，该数组以相同顺序存储在数组的连续元素中。
`String`	`toString()` 返回此集合的字符串表示形式。

From class java.lang.Object

From interface java.util.Queue

From interface java.util.Collection

`abstract boolean`	`add(E e)` 确保此集合包含指定的元素（可选操作）。
`abstract boolean`	`addAll(Collection<? extends E> c)` 将指定集合中的所有元素添加到此集合（可选操作）。
`abstract void`	`clear()` 从该集合中删除所有元素（可选操作）。
`abstract boolean`	`contains(Object o)` 如果此集合包含指定的元素，则返回 `true` 。
`abstract boolean`	`containsAll(Collection<?> c)` 如果此集合包含指定集合中的所有元素，则返回 `true` 。
`abstract boolean`	`equals(Object o)` 将指定的对象与此集合进行比较以获得相等性。
`abstract int`	`hashCode()` 返回此集合的哈希码值。
`abstract boolean`	`isEmpty()` 如果此集合不包含元素，则返回 `true` 。
`abstract Iterator<E>`	`iterator()` 返回此集合中元素的迭代器。
`default Stream<E>`	`parallelStream()` 返回一个可能与此集合并行的 `Stream`作为其源。
`abstract boolean`	`remove(Object o)` 从该集合中移除指定元素的单个实例（如果存在）（可选操作）。
`abstract boolean`	`removeAll(Collection<?> c)` 删除指定集合中包含的所有此集合的元素（可选操作）。
`default boolean`	`removeIf(Predicate<? super E> filter)` 删除此集合中满足给定谓词的所有元素。
`abstract boolean`	`retainAll(Collection<?> c)` 仅保留包含在指定集合中的此集合中的元素（可选操作）。
`abstract int`	`size()` 返回此集合中的元素数量。
`default Spliterator<E>`	`spliterator()` 在此集合中的元素上创建一个 `Spliterator` 。
`default Stream<E>`	`stream()` 以此集合作为源返回顺序 `Stream` 。
`abstract <T> T[]`	`toArray(T[] a)` 返回包含此集合中所有元素的数组; 返回数组的运行时类型是指定数组的运行时类型。
`abstract Object[]`	`toArray()` 返回包含此集合中所有元素的数组。

From interface java.util.concurrent.BlockingQueue

`abstract boolean`	`add(E e)` 将指定的元素插入此队列中，如果它是立即可行且不会违反容量限制，返回 `true`在成功和抛出 `IllegalStateException` ，如果当前没有空间可用。
`abstract boolean`	`contains(Object o)` 如果此队列包含指定的元素，则返回 `true` 。
`abstract int`	`drainTo(Collection<? super E> c)` 从该队列中移除所有可用的元素，并将它们添加到给定的集合中。
`abstract int`	`drainTo(Collection<? super E> c, int maxElements)` 最多从此队列中移除给定数量的可用元素，并将它们添加到给定集合中。
`abstract boolean`	`offer(E e)` 将指定的元素插入此队列中，如果它是立即可行且不会违反容量限制，返回 `true`在成功和 `false`如果当前没有空间可用。
`abstract boolean`	`offer(E e, long timeout, TimeUnit unit)` 将指定的元素插入此队列中，如有必要，等待指定的等待时间以使空间变为可用。
`abstract E`	`poll(long timeout, TimeUnit unit)` 检索并删除此队列的头部，如果元素变为可用，则等待达到指定的等待时间。
`abstract void`	`put(E e)` 将指定的元素插入此队列，等待空间变得可用时。
`abstract int`	`remainingCapacity()` 如果不存在内部限制，则返回此队列理想情况下（在没有内存或资源约束的情况下）接受的附加元素的数量，而不阻止;或 `Integer.MAX_VALUE` 。
`abstract boolean`	`remove(Object o)` 从该队列中移除指定元素的单个实例（如果存在）。
`abstract E`	`take()` 检索并删除此队列的头部，如果需要等待，直到元素变为可用。

From interface java.lang.Iterable

Public constructors

DelayQueue

Added in API level 1

DelayQueue ()

创建最初为空的新的 DelayQueue 。

DelayQueue

Added in API level 1

DelayQueue (Collection<? extends E> c)

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

Parameters
`c`	`Collection`: the collection of elements to initially contain

Throws
`NullPointerException`	if the specified collection or any of its elements are null

Public methods

add

Added in API level 1

boolean add (E e)

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

Parameters
`e`	`E`: the element to add

Returns
`boolean`	`true` (as specified by `add(E)`)

Throws
`NullPointerException`	if the specified element is null

clear

Added in API level 1

void clear ()

原子上从这个延迟队列中删除所有元素。此通话返回后，队列将为空。未等待延迟的元素不会等待; 他们只是从队列中被丢弃。

drainTo

Added in API level 1

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

最多从此队列中移除给定数量的可用元素，并将它们添加到给定集合中。尝试将元素添加到集合c遇到的故障可能导致元素不在任何集合中，或者在引发关联异常时集合中的任何一个集合或两个集合都不在元素中。尝试将队列IllegalArgumentException自身导致IllegalArgumentException 。此外，如果在操作正在进行时修改了指定的集合，则此操作的行为未定义。

Parameters
`c`	`Collection`: the collection to transfer elements into
`maxElements`	`int`: the maximum number of elements to transfer

Returns
`int`	the number of elements transferred

Throws
`UnsupportedOperationException`
`ClassCastException`
`NullPointerException`
`IllegalArgumentException`

drainTo

Added in API level 1

int drainTo (Collection<? super E> c)

从该队列中移除所有可用的元素，并将它们添加到给定的集合中。该操作可能比重复轮询该队列更有效。尝试将元素添加到集合c遇到的故障可能导致元素不在任何一个或两个集合中，当引发关联的异常时。尝试排除队列本身导致IllegalArgumentException 。此外，如果在操作正在进行时修改了指定的集合，则此操作的行为未定义。

Parameters
`c`	`Collection`: the collection to transfer elements into

Returns
`int`	the number of elements transferred

Throws
`UnsupportedOperationException`
`ClassCastException`
`NullPointerException`
`IllegalArgumentException`

iterator

Added in API level 1

Iterator<E> iterator ()

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

返回的迭代器是 weakly consistent 。

Returns
`Iterator<E>`	an iterator over the elements in this queue

offer

Added in API level 1

boolean offer (E e)

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

Parameters
`e`	`E`: the element to add

Returns
`boolean`	`true`

Throws
`NullPointerException`	if the specified element is null

offer

Added in API level 1

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

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

Parameters
`e`	`E`: the element to add
`timeout`	`long`: This parameter is ignored as the method never blocks
`unit`	`TimeUnit`: This parameter is ignored as the method never blocks

Returns
`boolean`	`true`

Throws
`NullPointerException`

peek

Added in API level 1

E peek ()

检索但不移除此队列的头部，或者如果此队列为空，则返回null 。与poll不同，如果队列中没有可用的过期元素，则此方法返回下一个将过期的元素（如果存在）。

Returns
`E`	the head of this queue, or `null` if this queue is empty

poll

Added in API level 1

E poll (long timeout, 
                TimeUnit unit)

检索并删除此队列的头部，如果需要等待，直到此队列上有延迟过期的元素，或者指定的等待时间过期。

Parameters
`timeout`	`long`: how long to wait before giving up, in units of `unit`
`unit`	`TimeUnit`: a `TimeUnit` determining how to interpret the `timeout` parameter

Returns
`E`	the head of this queue, or `null` if the specified waiting time elapses before an element with an expired delay becomes available

Throws
`InterruptedException`

poll

Added in API level 1

E poll ()

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

Returns
`E`	the head of this queue, or `null` if this queue has no elements with an expired delay

put

Added in API level 1

void put (E e)

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

Parameters
`e`	`E`: the element to add

Throws
`NullPointerException`

remainingCapacity

Added in API level 1

int remainingCapacity ()

始终返回 Integer.MAX_VALUE因为 DelayQueue不受容量限制。

Returns
`int`	`Integer.MAX_VALUE`

remove

Added in API level 1

boolean remove (Object o)

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

Parameters
`o`	`Object`: element to be removed from this collection, if present

Returns
`boolean`	`true` if an element was removed as a result of this call

size

Added in API level 1

int size ()

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

Returns
`int`	the number of elements in this collection

take

Added in API level 1

E take ()

检索并删除此队列的头部，如果有必要，请等待，直到此队列中有延迟过期的元素可用。

Returns
`E`	the head of this queue

Throws
`InterruptedException`

toArray

Added in API level 1

T[] toArray (T[] a)

返回包含此队列中所有元素的数组; 返回数组的运行时类型是指定数组的运行时类型。返回的数组元素没有特定的顺序。如果队列适合指定的数组，则返回其中。否则，将使用指定数组的运行时类型和此队列的大小分配一个新数组。

如果此队列符合指定数组并有空余空间（即，数组的元素多于此队列），则紧随队列尾部的阵列中的元素将设置为 null 。

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

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

 Delayed[] a = q.toArray(new Delayed[0]);

Note that toArray(new Object[0]) is identical in function to toArray().

Parameters
`a`	`T`: the array into which the elements of the queue are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose

Returns
`T[]`	an array containing all of the elements in this queue

Throws
`ArrayStoreException`	if the runtime type of the specified array is not a supertype of the runtime type of every element in this queue
`NullPointerException`	if the specified array is null

toArray

Added in API level 1

Object[] toArray ()

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

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

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

Returns
`Object[]`	an array containing all of the elements in this queue

Interfaces

Classes

Enums

Exceptions

Most visited

Recently visited

Results for

DelayQueue

Summary

Public constructors

Public methods

Inherited methods

Public constructors

DelayQueue

DelayQueue

Public methods

add

clear

drainTo

drainTo

iterator

offer

offer

peek

poll

poll

put

remainingCapacity

remove

size

take

toArray

toArray