Skip to content

Most visited

Recently visited

navigation

SynchronousQueue

public class SynchronousQueue
extends AbstractQueue<E> implements BlockingQueue<E>, Serializable

java.lang.Object
   ↳ java.util.AbstractCollection<E>
     ↳ java.util.AbstractQueue<E>
       ↳ java.util.concurrent.SynchronousQueue<E>


A blocking queue in which each insert operation must wait for a corresponding remove operation by another thread, and vice versa. A synchronous queue does not have any internal capacity, not even a capacity of one. You cannot peek at a synchronous queue because an element is only present when you try to remove it; you cannot insert an element (using any method) unless another thread is trying to remove it; you cannot iterate as there is nothing to iterate. The head of the queue is the element that the first queued inserting thread is trying to add to the queue; if there is no such queued thread then no element is available for removal and poll() will return null. For purposes of other Collection methods (for example contains), a SynchronousQueue acts as an empty collection. This queue does not permit null elements.

Synchronous queues are similar to rendezvous channels used in CSP and Ada. They are well suited for handoff designs, in which an object running in one thread must sync up with an object running in another thread in order to hand it some information, event, or task.

This class supports an optional fairness policy for ordering waiting producer and consumer threads. By default, this ordering is not guaranteed. However, a queue constructed with fairness set to true grants threads access in FIFO order.

This class and its iterator implement all of the optional methods of the Collection and Iterator interfaces.

Summary

Public constructors

SynchronousQueue()

Creates a SynchronousQueue with nonfair access policy.

SynchronousQueue(boolean fair)

Creates a SynchronousQueue with the specified fairness policy.

Public methods

void clear()

Does nothing.

boolean contains(Object o)

Always returns false.

boolean containsAll(Collection<?> c)

Returns false unless the given collection is empty.

int drainTo(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.

int drainTo(Collection<? super E> c)

Removes all available elements from this queue and adds them to the given collection.

boolean isEmpty()

Always returns true.

Iterator<E> iterator()

Returns an empty iterator in which hasNext always returns false.

boolean offer(E e)

Inserts the specified element into this queue, if another thread is waiting to receive it.

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

Inserts the specified element into this queue, waiting if necessary up to the specified wait time for another thread to receive it.

E peek()

Always returns null.

E poll(long timeout, TimeUnit unit)

Retrieves and removes the head of this queue, waiting if necessary up to the specified wait time, for another thread to insert it.

E poll()

Retrieves and removes the head of this queue, if another thread is currently making an element available.

void put(E e)

Adds the specified element to this queue, waiting if necessary for another thread to receive it.

int remainingCapacity()

Always returns zero.

boolean remove(Object o)

Always returns false.

boolean removeAll(Collection<?> c)

Always returns false.

boolean retainAll(Collection<?> c)

Always returns false.

int size()

Always returns zero.

Spliterator<E> spliterator()

Returns an empty spliterator in which calls to trySplit() always return null.

E take()

Retrieves and removes the head of this queue, waiting if necessary for another thread to insert it.

<T> T[] toArray(T[] a)

Sets the zeroth element of the specified array to null (if the array has non-zero length) and returns it.

Object[] toArray()

Returns a zero-length array.

String toString()

Always returns "[]".

Inherited methods

From class java.util.AbstractQueue
From class java.util.AbstractCollection
From class java.lang.Object
From interface java.util.Queue
From interface java.util.Collection
From interface java.util.concurrent.BlockingQueue
From interface java.lang.Iterable

Public constructors

SynchronousQueue

Added in API level 1
SynchronousQueue ()

Creates a SynchronousQueue with nonfair access policy.

SynchronousQueue

Added in API level 1
SynchronousQueue (boolean fair)

Creates a SynchronousQueue with the specified fairness policy.

Parameters
fair boolean: if true, waiting threads contend in FIFO order for access; otherwise the order is unspecified.

Public methods

clear

Added in API level 1
void clear ()

Does nothing. A SynchronousQueue has no internal capacity.

contains

Added in API level 1
boolean contains (Object o)

Always returns false. A SynchronousQueue has no internal capacity.

Parameters
o Object: the element
Returns
boolean false

containsAll

Added in API level 1
boolean containsAll (Collection<?> c)

Returns false unless the given collection is empty. A SynchronousQueue has no internal capacity.

Parameters
c Collection: the collection
Returns
boolean false unless given collection is empty

drainTo

Added in API level 1
int drainTo (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. A failure encountered while attempting to add elements to collection c may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

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)

Removes all available elements from this queue and adds them to the given collection. This operation may be more efficient than repeatedly polling this queue. A failure encountered while attempting to add elements to collection c may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Parameters
c Collection: the collection to transfer elements into
Returns
int the number of elements transferred
Throws
UnsupportedOperationException
ClassCastException
NullPointerException
IllegalArgumentException

isEmpty

Added in API level 1
boolean isEmpty ()

Always returns true. A SynchronousQueue has no internal capacity.

Returns
boolean true

iterator

Added in API level 1
Iterator<E> iterator ()

Returns an empty iterator in which hasNext always returns false.

Returns
Iterator<E> an empty iterator

offer

Added in API level 1
boolean offer (E e)

Inserts the specified element into this queue, if another thread is waiting to receive it.

Parameters
e E: the element to add
Returns
boolean true if the element was added to this queue, else false
Throws
NullPointerException if the specified element is null

offer

Added in API level 1
boolean offer (E e, 
                long timeout, 
                TimeUnit unit)

Inserts the specified element into this queue, waiting if necessary up to the specified wait time for another thread to receive it.

Parameters
e E: the element to add
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 a consumer appears
Throws
InterruptedException
NullPointerException

peek

Added in API level 1
E peek ()

Always returns null. A SynchronousQueue does not return elements unless actively waited on.

Returns
E null

poll

Added in API level 1
E poll (long timeout, 
                TimeUnit unit)

Retrieves and removes the head of this queue, waiting if necessary up to the specified wait time, for another thread to insert it.

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 is present
Throws
InterruptedException

poll

Added in API level 1
E poll ()

Retrieves and removes the head of this queue, if another thread is currently making an element available.

Returns
E the head of this queue, or null if no element is available

put

Added in API level 1
void put (E e)

Adds the specified element to this queue, waiting if necessary for another thread to receive it.

Parameters
e E: the element to add
Throws
InterruptedException
NullPointerException

remainingCapacity

Added in API level 1
int remainingCapacity ()

Always returns zero. A SynchronousQueue has no internal capacity.

Returns
int zero

remove

Added in API level 1
boolean remove (Object o)

Always returns false. A SynchronousQueue has no internal capacity.

Parameters
o Object: the element to remove
Returns
boolean false

removeAll

Added in API level 1
boolean removeAll (Collection<?> c)

Always returns false. A SynchronousQueue has no internal capacity.

Parameters
c Collection: the collection
Returns
boolean false

retainAll

Added in API level 1
boolean retainAll (Collection<?> c)

Always returns false. A SynchronousQueue has no internal capacity.

Parameters
c Collection: the collection
Returns
boolean false

size

Added in API level 1
int size ()

Always returns zero. A SynchronousQueue has no internal capacity.

Returns
int zero

spliterator

Added in API level 24
Spliterator<E> spliterator ()

Returns an empty spliterator in which calls to trySplit() always return null.

Returns
Spliterator<E> an empty spliterator

take

Added in API level 1
E take ()

Retrieves and removes the head of this queue, waiting if necessary for another thread to insert it.

Returns
E the head of this queue
Throws
InterruptedException

toArray

Added in API level 1
T[] toArray (T[] a)

Sets the zeroth element of the specified array to null (if the array has non-zero length) and returns it.

Parameters
a T: the array
Returns
T[] the specified array
Throws
NullPointerException if the specified array is null

toArray

Added in API level 1
Object[] toArray ()

Returns a zero-length array.

Returns
Object[] a zero-length array

toString

Added in API level 1
String toString ()

Always returns "[]".

Returns
String "[]"
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.