Most visited

Recently visited

Results for

Added in API level 21

Summary: Methods | Inherited Methods | [Expand All]

TransferQueue

public interface TransferQueue
implements BlockingQueue<E>

java.util.concurrent.TransferQueue<E>

Known Indirect Subclasses

LinkedTransferQueue<E>

生产者可以等待消费者接收元素的BlockingQueue 。例如，在消息传递应用中， TransferQueue可能是有用的，其中生产者有时（使用方法transfer(E) ）等待消费者接收调用take或poll的元素，而在其他时间将put元素（通过方法put ）排队而不等待接收。 Non-blocking和time-out版本的tryTransfer也可用。 TransferQueue也可以通过hasWaitingConsumer()查询是否有任何线程在等待项目，这与peek操作是类推的。

像其他阻塞队列一样， TransferQueue可能受限于容量。如果是，则尝试传送操作可能最初阻止等待可用空间，和/或随后阻止等待消费者的接收。请注意，在与零容量的队列，例如SynchronousQueue ， put和transfer是有效的代名词。

Summary

Public methods
`abstract int`	`getWaitingConsumerCount()` 通过 `take()`或定时 `poll`返回等待接收元素的消费者数量的估计值。
`abstract boolean`	`hasWaitingConsumer()` 返回 `true` ，如果有至少一个消费者等待经由以接收元件 `take()`或定时 `poll` 。
`abstract void`	`transfer(E e)` 将元素转移给消费者，如果需要的话等待。
`abstract boolean`	`tryTransfer(E e)` 如果可能，立即将元素转移给等待的消费者。
`abstract boolean`	`tryTransfer(E e, long timeout, TimeUnit unit)` 如果在超时时间之前可以这样做，则将该元素传输给消费者。

Inherited methods

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.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.lang.Iterable

Public methods

getWaitingConsumerCount

Added in API level 21

int getWaitingConsumerCount ()

通过take()或定时poll返回等待接收元素的消费者数量的估计值。返回值近似于一种事态，如果消费者已经完成或放弃等待，这可能是不准确的。该值可能对监视和启发式有用，但不适用于同步控制。这种方法的实现可能明显比hasWaitingConsumer()慢。

Returns
`int`	the number of consumers waiting to receive elements

hasWaitingConsumer

Added in API level 21

boolean hasWaitingConsumer ()

返回true ，如果有至少一个消费者等待经由以接收元件take()或定时poll 。返回值代表了一种瞬间的事态。

Returns
`boolean`	`true` if there is at least one waiting consumer

transfer

Added in API level 21

void transfer (E e)

将元素转移给消费者，如果需要的话等待。

更确切地说，如果存在消费者已经等待接收它（在 take()或定时 poll ），则立即传送指定的元素，否则等待直到消费者接收到该元素。

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

Throws
`InterruptedException`	if interrupted while waiting, in which case the element is not left enqueued
`ClassCastException`	if the class of the specified element prevents it from being added to this queue
`NullPointerException`	if the specified element is null
`IllegalArgumentException`	if some property of the specified element prevents it from being added to this queue

tryTransfer

Added in API level 21

boolean tryTransfer (E e)

如果可能，立即将元素转移给等待的消费者。

更确切地说，如果存在消费者已经等待接收它（在 take()或定时 poll ），则立即传送指定的元素，否则返回 false而不 false元素。

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

Returns
`boolean`	`true` if the element was transferred, else `false`

Throws
`ClassCastException`	if the class of the specified element prevents it from being added to this queue
`NullPointerException`	if the specified element is null
`IllegalArgumentException`	if some property of the specified element prevents it from being added to this queue

tryTransfer

Added in API level 21

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

如果在超时时间之前可以这样做，则将该元素传输给消费者。

更确切地说，如果消费者已经等待接收它（ take()或定时 poll ），则立即传输指定的元素，否则等到消费者接收到该元素为止，如果在该元素可能之前经过了指定的等待时间，则返回 false转入。

Parameters
`e`	`E`: the element to transfer
`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
`boolean`	`true` if successful, or `false` if the specified waiting time elapses before completion, in which case the element is not left enqueued

Throws
`InterruptedException`	if interrupted while waiting, in which case the element is not left enqueued
`ClassCastException`	if the class of the specified element prevents it from being added to this queue
`NullPointerException`	if the specified element is null
`IllegalArgumentException`	if some property of the specified element prevents it from being added to this queue

Interfaces

Classes

Enums

Exceptions

Most visited

Recently visited

Results for

TransferQueue

Summary

Public methods

Inherited methods

Public methods

getWaitingConsumerCount

hasWaitingConsumer

transfer

tryTransfer

tryTransfer