compact1, compact2, compact3

java.util.concurrent

Class SynchronousQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

java.util.concurrent.SynchronousQueue<E>

参数类型

E -元素举行此集合中的类型

All Implemented Interfaces:

Serializable， Iterable ， Collection ， BlockingQueue ， Queue

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

一个 blocking queue其中每个插入操作必须等待相应的删除操作由另一个线程，反之亦然。同步队列没有任何内部容量，甚至没有一个容量。你不能 peek在同步队列因为元素只存在当你试图删除它；你不能插入一个元素（使用任何方法）除非另一个线程试图删除它；你不能因为没有迭代迭代。队列的头部是第一个排队的插入线程试图添加到队列的元素；如果没有这样的排队线然后没有元素可用于去除和 poll()将返回 null。对于其他 Collection方法的目的（例如 contains），一个 SynchronousQueue作为空集合。这个队列不允许 null元素。

同步队列类似交会用于CSP和艾达通道。它们非常适合于切换设计，其中一个线程在一个线程中运行的对象必须与另一个线程中运行的对象同步，以便将一些信息、事件或任务。

这个类支持一个可选的公平策略，用于订购等待的生产者和消费者线程。默认情况下，此顺序无法保证。然而，公平设置true补助按照先进先出的顺序构建了一个线程访问队列。

这个类和它的迭代器实现所有的可选方法的Collection和Iterator接口。

这个班的一员 Java Collections Framework。

从以下版本开始：

一点五

另请参见：

Serialized Form

构造方法摘要

构造方法

Constructor and Description
SynchronousQueue() 创建一个nonfair准入政策 SynchronousQueue。
SynchronousQueue(boolean fair) 创建一个具有指定公平政策 SynchronousQueue。

方法摘要

Modifier and Type	Method and Description
void	clear() 什么也不做。
boolean	contains(Object o) 总是返回 false。
boolean	containsAll(Collection<?> c) 返回 false除非给定集合是空的。
int	drainTo(Collection<? super E> c) 从这个队列中删除所有可用的元素，并将它们添加到给定的集合中。
int	drainTo(Collection<? super E> c, int maxElements) 从这个队列中移除给定数量的可用元素，并将它们添加到给定的集合中。
boolean	isEmpty() 总是返回 true。
Iterator<E>	iterator() 返回一个空的迭代器， hasNext总是返回 false。
boolean	offer(E e) 如果另一个线程正在等待接收到该队列，则将指定的元素插入到该队列中。
boolean	offer(E e, long timeout, TimeUnit unit) 将指定的元素插入到队列中，等待必要的时间到指定的等待另一个线程接收到的等待时间。
E	peek() 总是返回 null。
E	poll() 检索和删除此队列的头，如果另一个线程正在使用可用的元素。
E	poll(long timeout, TimeUnit unit) 检索并删除此队列的头，等待必要时到指定的等待时间，另一个线程插入它。
void	put(E e) 将指定的元素添加到这个队列中，等待另一个线程接收它的必要。
int	remainingCapacity() 总是返回零。
boolean	remove(Object o) 总是返回 false。
boolean	removeAll(Collection<?> c) 总是返回 false。
boolean	retainAll(Collection<?> c) 总是返回 false。
int	size() 总是返回零。
Spliterator<E>	spliterator() 返回的空spliterator调用 Spliterator.trySplit()总是返回 null。
E	take() 检索并删除此队列的头，等待另一个线程是否需要插入它。
Object[]	toArray() 返回一零个长度数组。
<T> T[]	toArray(T[] a) 设置指定数组 null第0个元素（如果数组长度不为零）并返回。

Methods inherited from class java.util.AbstractQueue

add, addAll, element, remove

Methods inherited from class java.util.AbstractCollection

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.concurrent.BlockingQueue

add

Methods inherited from interface java.util.Queue

element, remove

Methods inherited from interface java.util.Collection

addAll, equals, hashCode, parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

SynchronousQueue

public SynchronousQueue()

创建一个nonfair准入政策 SynchronousQueue。

SynchronousQueue

public SynchronousQueue(boolean fair)

创建一个具有指定公平政策 SynchronousQueue。

参数

fair -如果是真的，等待的线程争先进先出的顺序访问；否则订单不详。

方法详细信息

put

public void put(E e)
         throws InterruptedException

将指定的元素添加到这个队列中，等待另一个线程接收它的必要。

Specified by:

put 接口 BlockingQueue<E>

参数

e -元素添加

异常

InterruptedException如果中断等待

NullPointerException -如果指定元素为null

offer

public boolean offer(E e,
                     long timeout,
                     TimeUnit unit)
              throws InterruptedException

将指定的元素插入到队列中，等待必要的时间到指定的等待另一个线程接收到的等待时间。

Specified by:

offer 接口 BlockingQueue<E>

参数

e -元素添加

timeout -多久才放弃等待，在单位 unit

unit - TimeUnit确定如何解释 timeout参数

结果

true如果成功，或 false如果指定的等待时间流逝之前，消费者出现

异常

InterruptedException如果中断等待

NullPointerException -如果指定元素为null

offer

public boolean offer(E e)

如果另一个线程正在等待接收到该队列，则将指定的元素插入到该队列中。

Specified by:

offer 接口 BlockingQueue<E>

Specified by:

offer 接口 Queue<E>

参数

e -元素添加

结果

true如果元素被添加到这个队列，否则 false

异常

NullPointerException -如果指定元素为null

take

public E take()
       throws InterruptedException

检索并删除此队列的头，等待另一个线程是否需要插入它。

Specified by:

take 接口 BlockingQueue<E>

结果

这个队列的头

异常

InterruptedException如果中断等待

poll

public E poll(long timeout,
              TimeUnit unit)
       throws InterruptedException

检索并删除此队列的头，等待必要时到指定的等待时间，另一个线程插入它。

Specified by:

poll 接口 BlockingQueue<E>

参数

timeout -多久才放弃等待，在单位 unit

unit - TimeUnit确定如何解释 timeout参数

结果

这个队列头，或 null如果指定的等待时间过去之前的元素是存在的

异常

InterruptedException如果中断等待

poll

public E poll()

检索和删除此队列的头，如果另一个线程正在使用可用的元素。

Specified by:

poll 接口 Queue<E>

结果

这个队列头，或 null如果没有元素是可用的

isEmpty

public boolean isEmpty()

总是返回 true。一个 SynchronousQueue没有内部能力。

Specified by:

isEmpty 接口 Collection<E>

重写：

isEmpty 方法重写，继承类 AbstractCollection<E>

结果

true

size

public int size()

总是返回零。一个 SynchronousQueue没有内部能力。

Specified by:

size 接口 Collection<E>

Specified by:

size 方法重写，继承类 AbstractCollection<E>

结果

零

remainingCapacity

public int remainingCapacity()

总是返回零。一个 SynchronousQueue没有内部能力。

Specified by:

remainingCapacity 接口 BlockingQueue<E>

结果

零

clear

public void clear()

什么也不做。一个 SynchronousQueue没有内部能力。

Specified by:

clear 接口 Collection<E>

重写：

clear 方法重写，继承类 AbstractQueue<E>

contains

public boolean contains(Object o)

总是返回一个 false SynchronousQueue没有内部能力。

Specified by:

contains 接口 Collection<E>

Specified by:

contains 接口 BlockingQueue<E>

重写：

contains 方法重写，继承类 AbstractCollection<E>

参数

o -元素

结果

false

remove

public boolean remove(Object o)

总是返回 false。一个 SynchronousQueue没有内部能力。

Specified by:

remove 接口 Collection<E>

Specified by:

remove 接口 BlockingQueue<E>

重写：

remove 方法重写，继承类 AbstractCollection<E>

参数

o -要移除的元素

结果

false

containsAll

public boolean containsAll(Collection<?> c)

返回 false除非给定集合是空的。一个 SynchronousQueue没有内部能力。

Specified by:

containsAll 接口 Collection<E>

重写：

containsAll 方法重写，继承类 AbstractCollection<E>

参数

c -集合

结果

false除非给定集合是空的

另请参见：

AbstractCollection.contains(Object)

removeAll

public boolean removeAll(Collection<?> c)

总是返回一个 false SynchronousQueue没有内部能力。

Specified by:

removeAll 接口 Collection<E>

重写：

removeAll 方法重写，继承类 AbstractCollection<E>

参数

c -集合

结果

false

另请参见：

AbstractCollection.remove(Object)， AbstractCollection.contains(Object)

retainAll

public boolean retainAll(Collection<?> c)

总是返回 false。一个 SynchronousQueue没有内部能力。

Specified by:

retainAll 接口 Collection<E>

重写：

retainAll 方法重写，继承类 AbstractCollection<E>

参数

c -集合

结果

false

另请参见：

AbstractCollection.remove(Object)， AbstractCollection.contains(Object)

peek

public E peek()

总是返回 null。一个 SynchronousQueue不返回元素除非积极等待。

Specified by:

peek 接口 Queue<E>

结果

null

iterator

public Iterator<E> iterator()

返回一个空的迭代器， hasNext总是返回 false。

Specified by:

iterator 接口 Iterable<E>

Specified by:

iterator 接口 Collection<E>

Specified by:

iterator 方法重写，继承类 AbstractCollection<E>

结果

一个空的迭代器

spliterator

public Spliterator<E> spliterator()

返回的空spliterator调用 Spliterator.trySplit()总是返回 null。

Specified by:

spliterator 接口 Iterable<E>

Specified by:

spliterator 接口 Collection<E>

结果

一个空的spliterator

从以下版本开始：

一点八

toArray

public Object[] toArray()

返回一零个长度数组。

Specified by:

toArray 接口 Collection<E>

重写：

toArray 方法重写，继承类 AbstractCollection<E>

结果

一零长度数组

toArray

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

集 null指定数组的第0个元素（如果数组长度不为零）并返回。

Specified by:

toArray 接口 Collection<E>

重写：

toArray 方法重写，继承类 AbstractCollection<E>

参数类型

T -数组的运行时类型包含集合

参数

a -阵列

结果

指定的数组

异常

NullPointerException -如果指定的数组是空的

drainTo

public int drainTo(Collection<? super E> c)

从接口复制的描述： BlockingQueue

从这个队列中删除所有可用的元素，并将它们添加到给定的集合中。此操作可能比重复轮询此队列更有效。一个在试图收集 c添加元素可能会导致元素在没有遭遇过失败，或集合时相关的异常被抛出。试图排队列本身造成 IllegalArgumentException。此外，当操作正在进行中时，此操作的行为是不确定的，如果指定的集合被修改了。

Specified by:

drainTo 接口 BlockingQueue<E>

参数

c -收集传递元素

结果

传输的元素数

异常

UnsupportedOperationException如果添加元素不按指定集合的支持

ClassCastException -如果该队列的元素类型阻止其加入指定集合

NullPointerException -如果指定集合为空

IllegalArgumentException -如果指定集合的队列，该队列或一个元素的一些特性可以防止它被添加到指定的集合

drainTo

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

从接口复制的描述： BlockingQueue

从这个队列中移除给定数量的可用元素，并将它们添加到给定的集合中。一个在试图收集 c添加元素可能会导致元素在没有遭遇过失败，或集合时相关的异常被抛出。试图排队列本身造成 IllegalArgumentException。此外，当操作正在进行中时，此操作的行为是不确定的，如果指定的集合被修改了。

Specified by:

drainTo 接口 BlockingQueue<E>

参数

c -收集传递元素

maxElements -元素的最大数量的转移

结果

传输的元素数

异常

UnsupportedOperationException如果添加元素不按指定集合的支持

ClassCastException -如果该队列的元素类型阻止其加入指定集合

NullPointerException -如果指定集合为空

IllegalArgumentException -如果指定集合的队列，该队列或一个元素的一些特性可以防止它被添加到指定的集合