# TransferQueue

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Methods](https://developer.android.com/reference/java/util/concurrent/TransferQueue#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/java/util/concurrent/TransferQueue#inhmethods)  

# TransferQueue

`
public


interface
TransferQueue
`  
`


implements

`[BlockingQueue](https://developer.android.com/reference/java/util/concurrent/BlockingQueue)`<E>


`

|-----------------------------------------|
| java.util.concurrent.TransferQueue\<E\> |

|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Known indirect subclasses [LinkedTransferQueue](https://developer.android.com/reference/java/util/concurrent/LinkedTransferQueue)\<E\> |--------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------| | [LinkedTransferQueue](https://developer.android.com/reference/java/util/concurrent/LinkedTransferQueue)\<E\> | An unbounded[TransferQueue](https://developer.android.com/reference/java/util/concurrent/TransferQueue)based on linked nodes. | |

<br />

*** ** * ** ***

A[BlockingQueue](https://developer.android.com/reference/java/util/concurrent/BlockingQueue)in which producers may wait for consumers to receive elements. A`TransferQueue`may be useful for example in message passing applications in which producers sometimes (using method[transfer(E)](https://developer.android.com/reference/java/util/concurrent/TransferQueue#transfer(E))) await receipt of elements by consumers invoking`take`or`poll`, while at other times enqueue elements (via method`put`) without waiting for receipt.[Non-blocking](https://developer.android.com/reference/java/util/concurrent/TransferQueue#tryTransfer(E))and[time-out](https://developer.android.com/reference/java/util/concurrent/TransferQueue#tryTransfer(E,%20long,%20java.util.concurrent.TimeUnit))versions of`tryTransfer`are also available. A`TransferQueue`may also be queried, via[hasWaitingConsumer()](https://developer.android.com/reference/java/util/concurrent/TransferQueue#hasWaitingConsumer()), whether there are any threads waiting for items, which is a converse analogy to a`peek`operation.

Like other blocking queues, a`TransferQueue`may be capacity bounded. If so, an attempted transfer operation may initially block waiting for available space, and/or subsequently block waiting for reception by a consumer. Note that in a queue with zero capacity, such as[SynchronousQueue](https://developer.android.com/reference/java/util/concurrent/SynchronousQueue),`put`and`transfer`are effectively synonymous.

This interface is a member of the[Java Collections Framework](https://reference/java/util/package-summary.html#CollectionsFramework).

## Summary

|                                                                                                                                                                                                                                     ### Public methods                                                                                                                                                                                                                                      ||
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` abstract int`     | ` `[getWaitingConsumerCount](https://developer.android.com/reference/java/util/concurrent/TransferQueue#getWaitingConsumerCount())`() ` Returns an estimate of the number of consumers waiting to receive elements via[BlockingQueue.take()](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#take())or timed[poll](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#poll(long,%20java.util.concurrent.TimeUnit)). |
| ` abstract boolean` | ` `[hasWaitingConsumer](https://developer.android.com/reference/java/util/concurrent/TransferQueue#hasWaitingConsumer())`() ` Returns`true`if there is at least one consumer waiting to receive an element via[BlockingQueue.take()](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#take())or timed[poll](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#poll(long,%20java.util.concurrent.TimeUnit)).         |
| ` abstract void`    | ` `[transfer](https://developer.android.com/reference/java/util/concurrent/TransferQueue#transfer(E))`(E e) ` Transfers the element to a consumer, waiting if necessary to do so.                                                                                                                                                                                                                                                                                      |
| ` abstract boolean` | ` `[tryTransfer](https://developer.android.com/reference/java/util/concurrent/TransferQueue#tryTransfer(E))`(E e) ` Transfers the element to a waiting consumer immediately, if possible.                                                                                                                                                                                                                                                                              |
| ` abstract boolean` | ` `[tryTransfer](https://developer.android.com/reference/java/util/concurrent/TransferQueue#tryTransfer(E,%20long,%20java.util.concurrent.TimeUnit))`(E e, long timeout, `[TimeUnit](https://developer.android.com/reference/java/util/concurrent/TimeUnit)` unit) ` Transfers the element to a consumer if it is possible to do so before the timeout elapses.                                                                                                        |

| ### Inherited methods |
|-----------------------|---|
| From interface` `[java.util.concurrent.BlockingQueue](https://developer.android.com/reference/java/util/concurrent/BlockingQueue)` ` |---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract boolean` | ` `[add](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#add(E))`(E e) ` Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions, returning`true`upon success and throwing an`IllegalStateException`if no space is currently available.                                                   | | ` abstract boolean` | ` `[contains](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#contains(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Returns`true`if this queue contains the specified element.                                                                                                                                | | ` abstract int`     | ` `[drainTo](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#drainTo(java.util.Collection<?%20super%20E>))`(`[Collection](https://developer.android.com/reference/java/util/Collection)`<? super E> c) ` Removes all available elements from this queue and adds them to the given collection.                                                                 | | ` abstract int`     | ` `[drainTo](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#drainTo(java.util.Collection<?%20super%20E>,%20int))`(`[Collection](https://developer.android.com/reference/java/util/Collection)`<? super E> c, int maxElements) ` Removes at most the given number of available elements from this queue and adds them to the given collection.                 | | ` abstract boolean` | ` `[offer](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#offer(E))`(E e) ` Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions, returning`true`upon success and`false`if no space is currently available.                                                                           | | ` abstract boolean` | ` `[offer](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#offer(E,%20long,%20java.util.concurrent.TimeUnit))`(E e, long timeout, `[TimeUnit](https://developer.android.com/reference/java/util/concurrent/TimeUnit)` unit) ` Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available. | | ` abstract E`       | ` `[poll](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#poll(long,%20java.util.concurrent.TimeUnit))`(long timeout, `[TimeUnit](https://developer.android.com/reference/java/util/concurrent/TimeUnit)` unit) ` Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.         | | ` abstract void`    | ` `[put](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#put(E))`(E e) ` Inserts the specified element into this queue, waiting if necessary for space to become available.                                                                                                                                                                                    | | ` abstract int`     | ` `[remainingCapacity](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#remainingCapacity())`() ` Returns the number of additional elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking, or`Integer.MAX_VALUE`if there is no intrinsic limit.                                                        | | ` abstract boolean` | ` `[remove](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#remove(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Removes a single instance of the specified element from this queue, if it is present.                                                                                                         | | ` abstract E`       | ` `[take](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#take())`() ` Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.                                                                                                                                                                                  | ||
| From interface` `[java.util.Queue](https://developer.android.com/reference/java/util/Queue)` ` |---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract boolean` | ` `[add](https://developer.android.com/reference/java/util/Queue#add(E))`(E e) ` Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions, returning`true`upon success and throwing an`IllegalStateException`if no space is currently available. | | ` abstract E`       | ` `[element](https://developer.android.com/reference/java/util/Queue#element())`() ` Retrieves, but does not remove, the head of this queue.                                                                                                                                                                         | | ` abstract boolean` | ` `[offer](https://developer.android.com/reference/java/util/Queue#offer(E))`(E e) ` Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions.                                                                                                   | | ` abstract E`       | ` `[peek](https://developer.android.com/reference/java/util/Queue#peek())`() ` Retrieves, but does not remove, the head of this queue, or returns`null`if this queue is empty.                                                                                                                                       | | ` abstract E`       | ` `[poll](https://developer.android.com/reference/java/util/Queue#poll())`() ` Retrieves and removes the head of this queue, or returns`null`if this queue is empty.                                                                                                                                                 | | ` abstract E`       | ` `[remove](https://developer.android.com/reference/java/util/Queue#remove())`() ` Retrieves and removes the head of this queue.                                                                                                                                                                                     | ||
| From interface` `[java.util.Collection](https://developer.android.com/reference/java/util/Collection)` ` |----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract boolean`                                                                          | ` `[add](https://developer.android.com/reference/java/util/Collection#add(E))`(E e) ` Ensures that this collection contains the specified element (optional operation).                                                                                                                                                                                                      | | ` abstract boolean`                                                                          | ` `[addAll](https://developer.android.com/reference/java/util/Collection#addAll(java.util.Collection<?%20extends%20E>))`(`[Collection](https://developer.android.com/reference/java/util/Collection)`<? extends E> c) ` Adds all of the elements in the specified collection to this collection (optional operation).                                                        | | ` abstract void`                                                                             | ` `[clear](https://developer.android.com/reference/java/util/Collection#clear())`() ` Removes all of the elements from this collection (optional operation).                                                                                                                                                                                                                 | | ` abstract boolean`                                                                          | ` `[contains](https://developer.android.com/reference/java/util/Collection#contains(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Returns`true`if this collection contains the specified element.                                                                                                                            | | ` abstract boolean`                                                                          | ` `[containsAll](https://developer.android.com/reference/java/util/Collection#containsAll(java.util.Collection<?>))`(`[Collection](https://developer.android.com/reference/java/util/Collection)`<?> c) ` Returns`true`if this collection contains all of the elements in the specified collection.                                                                          | | ` abstract boolean`                                                                          | ` `[equals](https://developer.android.com/reference/java/util/Collection#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Compares the specified object with this collection for equality.                                                                                                                               | | ` abstract int`                                                                              | ` `[hashCode](https://developer.android.com/reference/java/util/Collection#hashCode())`() ` Returns the hash code value for this collection.                                                                                                                                                                                                                                 | | ` abstract boolean`                                                                          | ` `[isEmpty](https://developer.android.com/reference/java/util/Collection#isEmpty())`() ` Returns`true`if this collection contains no elements.                                                                                                                                                                                                                              | | ` abstract `[Iterator](https://developer.android.com/reference/java/util/Iterator)`<E>`      | ` `[iterator](https://developer.android.com/reference/java/util/Collection#iterator())`() ` Returns an iterator over the elements in this collection.                                                                                                                                                                                                                        | | ` default `[Stream](https://developer.android.com/reference/java/util/stream/Stream)`<E>`    | ` `[parallelStream](https://developer.android.com/reference/java/util/Collection#parallelStream())`() ` Returns a possibly parallel`Stream`with this collection as its source.                                                                                                                                                                                               | | ` abstract boolean`                                                                          | ` `[remove](https://developer.android.com/reference/java/util/Collection#remove(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Removes a single instance of the specified element from this collection, if it is present (optional operation).                                                                                | | ` abstract boolean`                                                                          | ` `[removeAll](https://developer.android.com/reference/java/util/Collection#removeAll(java.util.Collection<?>))`(`[Collection](https://developer.android.com/reference/java/util/Collection)`<?> c) ` Removes all of this collection's elements that are also contained in the specified collection (optional operation).                                                    | | ` default boolean`                                                                           | ` `[removeIf](https://developer.android.com/reference/java/util/Collection#removeIf(java.util.function.Predicate<?%20super%20E>))`(`[Predicate](https://developer.android.com/reference/java/util/function/Predicate)`<? super E> filter) ` Removes all of the elements of this collection that satisfy the given predicate.                                                 | | ` abstract boolean`                                                                          | ` `[retainAll](https://developer.android.com/reference/java/util/Collection#retainAll(java.util.Collection<?>))`(`[Collection](https://developer.android.com/reference/java/util/Collection)`<?> c) ` Retains only the elements in this collection that are contained in the specified collection (optional operation).                                                      | | ` abstract int`                                                                              | ` `[size](https://developer.android.com/reference/java/util/Collection#size())`() ` Returns the number of elements in this collection.                                                                                                                                                                                                                                       | | ` default `[Spliterator](https://developer.android.com/reference/java/util/Spliterator)`<E>` | ` `[spliterator](https://developer.android.com/reference/java/util/Collection#spliterator())`() ` Creates a[Spliterator](https://developer.android.com/reference/java/util/Spliterator)over the elements in this collection.                                                                                                                                                 | | ` default `[Stream](https://developer.android.com/reference/java/util/stream/Stream)`<E>`    | ` `[stream](https://developer.android.com/reference/java/util/Collection#stream())`() ` Returns a sequential`Stream`with this collection as its source.                                                                                                                                                                                                                      | | ` abstract <T> T[]`                                                                          | ` `[toArray](https://developer.android.com/reference/java/util/Collection#toArray(T[]))`(T[] a) ` Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.                                                                                                                                 | | ` abstract `[Object[]](https://developer.android.com/reference/java/lang/Object)             | ` `[toArray](https://developer.android.com/reference/java/util/Collection#toArray())`() ` Returns an array containing all of the elements in this collection.                                                                                                                                                                                                                | | ` default <T> T[]`                                                                           | ` `[toArray](https://developer.android.com/reference/java/util/Collection#toArray(java.util.function.IntFunction<T[]>))`(`[IntFunction](https://developer.android.com/reference/java/util/function/IntFunction)`<T[]> generator) ` Returns an array containing all of the elements in this collection, using the provided`generator`function to allocate the returned array. | ||
| From interface` `[java.lang.Iterable](https://developer.android.com/reference/java/lang/Iterable)` ` |----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` default void`                                                                              | ` `[forEach](https://developer.android.com/reference/java/lang/Iterable#forEach(java.util.function.Consumer<?%20super%20T>))`(`[Consumer](https://developer.android.com/reference/java/util/function/Consumer)`<? super T> action) ` Performs the given action for each element of the`Iterable`until all elements have been processed or the action throws an exception. | | ` abstract `[Iterator](https://developer.android.com/reference/java/util/Iterator)`<E>`      | ` `[iterator](https://developer.android.com/reference/java/lang/Iterable#iterator())`() ` Returns an iterator over elements of type`T`.                                                                                                                                                                                                                                   | | ` default `[Spliterator](https://developer.android.com/reference/java/util/Spliterator)`<E>` | ` `[spliterator](https://developer.android.com/reference/java/lang/Iterable#spliterator())`() ` Creates a[Spliterator](https://developer.android.com/reference/java/util/Spliterator)over the elements described by this`Iterable`.                                                                                                                                       | ||

## Public methods

### getWaitingConsumerCount

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract int getWaitingConsumerCount ()
```

Returns an estimate of the number of consumers waiting to receive elements via[BlockingQueue.take()](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#take())or timed[poll](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#poll(long,%20java.util.concurrent.TimeUnit)). The return value is an approximation of a momentary state of affairs, that may be inaccurate if consumers have completed or given up waiting. The value may be useful for monitoring and heuristics, but not for synchronization control. Implementations of this method are likely to be noticeably slower than those for[hasWaitingConsumer()](https://developer.android.com/reference/java/util/concurrent/TransferQueue#hasWaitingConsumer()).

<br />

|                              Returns                              ||
|-------|------------------------------------------------------------|
| `int` | the number of consumers waiting to receive elements <br /> |

### hasWaitingConsumer

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract boolean hasWaitingConsumer ()
```

Returns`true`if there is at least one consumer waiting to receive an element via[BlockingQueue.take()](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#take())or timed[poll](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#poll(long,%20java.util.concurrent.TimeUnit)). The return value represents a momentary state of affairs.

<br />

|                              Returns                              ||
|-----------|--------------------------------------------------------|
| `boolean` | `true`if there is at least one waiting consumer <br /> |

### transfer

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract void transfer (E e)
```

Transfers the element to a consumer, waiting if necessary to do so.

More precisely, transfers the specified element immediately if there exists a consumer already waiting to receive it (in[BlockingQueue.take()](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#take())or timed[poll](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#poll(long,%20java.util.concurrent.TimeUnit))), else waits until the element is received by a consumer.

<br />

|                Parameters                ||
|-----|-------------------------------------|
| `e` | `E`: the element to transfer <br /> |

|                                                                                            Throws                                                                                            ||
|--------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
| [InterruptedException](https://developer.android.com/reference/java/lang/InterruptedException)         | if interrupted while waiting, in which case the element is not left enqueued         |
| [ClassCastException](https://developer.android.com/reference/java/lang/ClassCastException)             | if the class of the specified element prevents it from being added to this queue     |
| [NullPointerException](https://developer.android.com/reference/java/lang/NullPointerException)         | if the specified element is null                                                     |
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | if some property of the specified element prevents it from being added to this queue |

### tryTransfer

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract boolean tryTransfer (E e)
```

Transfers the element to a waiting consumer immediately, if possible.

More precisely, transfers the specified element immediately if there exists a consumer already waiting to receive it (in[BlockingQueue.take()](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#take())or timed[poll](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#poll(long,%20java.util.concurrent.TimeUnit))), otherwise returning`false`without enqueuing the element.

<br />

|                Parameters                ||
|-----|-------------------------------------|
| `e` | `E`: the element to transfer <br /> |

|                               Returns                               ||
|-----------|----------------------------------------------------------|
| `boolean` | `true`if the element was transferred, else`false` <br /> |

|                                                                                            Throws                                                                                            ||
|--------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
| [ClassCastException](https://developer.android.com/reference/java/lang/ClassCastException)             | if the class of the specified element prevents it from being added to this queue     |
| [NullPointerException](https://developer.android.com/reference/java/lang/NullPointerException)         | if the specified element is null                                                     |
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | if some property of the specified element prevents it from being added to this queue |

### tryTransfer

Added in[API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public abstract boolean tryTransfer (E e, 
                long timeout, 
                TimeUnit unit)
```

Transfers the element to a consumer if it is possible to do so before the timeout elapses.

More precisely, transfers the specified element immediately if there exists a consumer already waiting to receive it (in[BlockingQueue.take()](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#take())or timed[poll](https://developer.android.com/reference/java/util/concurrent/BlockingQueue#poll(long,%20java.util.concurrent.TimeUnit))), else waits until the element is received by a consumer, returning`false`if the specified wait time elapses before the element can be transferred.

<br />

|                                         Parameters                                          ||
|-----------|----------------------------------------------------------------------------------|
| `e`       | `E`: the element to transfer <br />                                              |
| `timeout` | `long`: how long to wait before giving up, in units of`unit` <br />              |
| `unit`    | `TimeUnit`: a`TimeUnit`determining how to interpret the`timeout`parameter <br /> |

|                                                                         Returns                                                                         ||
|-----------|----------------------------------------------------------------------------------------------------------------------------------------------|
| `boolean` | `true`if successful, or`false`if the specified waiting time elapses before completion, in which case the element is not left enqueued <br /> |

|                                                                                            Throws                                                                                            ||
|--------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
| [InterruptedException](https://developer.android.com/reference/java/lang/InterruptedException)         | if interrupted while waiting, in which case the element is not left enqueued         |
| [ClassCastException](https://developer.android.com/reference/java/lang/ClassCastException)             | if the class of the specified element prevents it from being added to this queue     |
| [NullPointerException](https://developer.android.com/reference/java/lang/NullPointerException)         | if the specified element is null                                                     |
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | if some property of the specified element prevents it from being added to this queue |