java.lang.Object java.util.AbstractCollection<E> java.util.AbstractQueue<E> java.util.concurrent.LinkedBlockingQueue<E>
E
- 此 collection 中所保存元素的类型。
public class LinkedBlockingQueue<E>
一个基于已链接节点的、范围任意的 blocking queue。此队列按 FIFO(先进先出)排序元素。队列的头部 是在队列中时间最长的元素。队列的尾部 是在队列中时间最短的元素。新元素插入到队列的尾部,并且队列获取操作会获得位于队列头部的元素。链接队列的吞吐量通常要高于基于数组的队列,但是在大多数并发应用程序中,其可预知的性能要低。
可选的容量范围构造方法参数作为防止队列过度扩展的一种方法。如果未指定容量,则它等于 Integer.MAX_VALUE
。除非插入节点会使队列超出容量,否则每次插入后会动态地创建链接节点。
此类及其迭代器实现 Collection
和 Iterator
接口的所有可选 方法。
此类是 Java Collections Framework 的成员。
构造方法摘要 | |
---|---|
LinkedBlockingQueue() 创建一个容量为 Integer.MAX_VALUE 的 LinkedBlockingQueue。 |
|
LinkedBlockingQueue(Collection<? extends E> c) 创建一个容量是 Integer.MAX_VALUE 的 LinkedBlockingQueue,最初包含给定 collection 的元素,元素按该 collection 迭代器的遍历顺序添加。 |
|
LinkedBlockingQueue(int capacity) 创建一个具有给定(固定)容量的 LinkedBlockingQueue。 |
方法摘要 | ||
---|---|---|
void |
clear() 从队列彻底移除所有元素。 |
|
int |
drainTo(Collection<? super E> c) 移除此队列中所有可用的元素,并将它们添加到给定 collection 中。 |
|
int |
drainTo(Collection<? super E> c, int maxElements) 最多从此队列中移除给定数量的可用元素,并将这些元素添加到给定 collection 中。 |
|
Iterator<E> |
iterator() 返回在队列中的元素上按适当顺序进行迭代的迭代器。 |
|
boolean |
offer(E e) 将指定元素插入到此队列的尾部(如果立即可行且不会超出此队列的容量),在成功时返回 true,如果此队列已满,则返回 false。 |
|
boolean |
offer(E e, long timeout, TimeUnit unit) 将指定元素插入到此队列的尾部,如有必要,则等待指定的时间以使空间变得可用。 |
|
E |
peek() 获取但不移除此队列的头;如果此队列为空,则返回 null。 |
|
E |
poll() 获取并移除此队列的头,如果此队列为空,则返回 null。 |
|
E |
poll(long timeout, TimeUnit unit) 获取并移除此队列的头部,在指定的等待时间前等待可用的元素(如果有必要)。 |
|
void |
put(E e) 将指定元素插入到此队列的尾部,如有必要,则等待空间变得可用。 |
|
int |
remainingCapacity() 返回理想情况下(没有内存和资源约束)此队列可接受并且不会被阻塞的附加元素数量。 |
|
boolean |
remove(Object o) 从此队列移除指定元素的单个实例(如果存在)。 |
|
int |
size() 返回队列中的元素个数。 |
|
E |
take() 获取并移除此队列的头部,在元素变得可用之前一直等待(如果有必要)。 |
|
Object[] |
toArray() 返回按适当顺序包含此队列中所有元素的数组。 |
|
|
toArray(T[] a) 返回按适当顺序包含此队列中所有元素的数组;返回数组的运行时类型是指定数组的运行时类型。 |
|
String |
toString() 返回此 collection 的字符串表示形式。 |
从类 java.util.AbstractQueue 继承的方法 |
---|
add, addAll, element, remove |
从类 java.util.AbstractCollection 继承的方法 |
---|
contains, containsAll, isEmpty, removeAll, retainAll |
从类 java.lang.Object 继承的方法 |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
从接口 java.util.concurrent.BlockingQueue 继承的方法 |
---|
add, contains |
从接口 java.util.Queue 继承的方法 |
---|
element, remove |
从接口 java.util.Collection 继承的方法 |
---|
addAll, containsAll, equals, hashCode, isEmpty, removeAll, retainAll |
构造方法详细信息 |
---|
public LinkedBlockingQueue()
Integer.MAX_VALUE
的
LinkedBlockingQueue。
public LinkedBlockingQueue(int capacity)
capacity
- 队列的容量
IllegalArgumentException
- 如果
capacity 未大于 0
public LinkedBlockingQueue(Collection<? extends E> c)
Integer.MAX_VALUE
的
LinkedBlockingQueue,最初包含给定 collection 的元素,元素按该 collection 迭代器的遍历顺序添加。
c
- 最初所包含元素所属的 collection
NullPointerException
- 如果指定 collection 或其所有元素均为 null
方法详细信息 |
---|
public int size()
Collection<E>
中的
size
AbstractCollection<E>
中的
size
public int remainingCapacity()
注意,不能 总是通过检查 remainingCapacity 来断定试图插入一个元素是否成功,因为可能是另一个线程将插入或移除某个元素。
BlockingQueue<E>
中的
remainingCapacity
public void put(E e) throws InterruptedException
BlockingQueue<E>
中的
put
e
- 要添加的元素
InterruptedException
- 如果在等待时被中断
NullPointerException
- 如果指定元素为 null
public boolean offer(E e, long timeout, TimeUnit unit) throws InterruptedException
BlockingQueue<E>
中的
offer
e
- 要添加的元素
timeout
- 放弃之前等待的时间长度,以
unit 为时间单位
unit
- 确定如何解释
timeout 参数的
TimeUnit
InterruptedException
- 如果在等待时被中断
NullPointerException
- 如果指定元素为 null
public boolean offer(E e)
add
方法,后者可能无法插入元素,而只是抛出一个异常。
e
- 要添加的元素
NullPointerException
- 如果指定元素为 null
public E take() throws InterruptedException
BlockingQueue
复制的描述
BlockingQueue<E>
中的
take
InterruptedException
- 如果在等待时被中断
public E poll(long timeout, TimeUnit unit) throws InterruptedException
BlockingQueue
复制的描述
BlockingQueue<E>
中的
poll
timeout
- 放弃之前要等待的时间长度,用
unit 的时间单位表示
unit
- 确定如何解释
timeout 参数的
TimeUnit
InterruptedException
- 如果在等待时被中断
public E poll()
public E peek()
public boolean remove(Object o)
Collection<E>
中的
remove
BlockingQueue<E>
中的
remove
AbstractCollection<E>
中的
remove
o
- 要从此队列移除的元素(如果存在)
public Object[] toArray()
由于此队列不维护对返回数组的任何引用,因而它是“安全的”。(换句话说,此方法必须分配一个新数组)。因此,调用者可以随意修改返回的数组。
此方法充当基于数组的 API 与基于 collection 的 API 之间的桥梁。
Collection<E>
中的
toArray
AbstractCollection<E>
中的
toArray
public <T> T[] toArray(T[] a)
如果指定的数组能容纳队列,并有剩余的空间(即数组的元素比队列的多),那么将数组中紧接队列尾部的元素设置为 null。
像 toArray()
方法一样,此方法充当基于数组的 API 与基于 collection 的 API 之间的桥梁。更进一步说,此方法允许对输出数组的运行时类型进行精确控制,在某些情况下,可以用来节省分配开销。
假定 x 是只包含字符串的一个已知队列。以下代码用来将该队列转储到一个新分配的 String 数组:
String[] y = x.toArray(new String[0]);注意, toArray(new Object[0]) 和 toArray() 在功能上是相同的。
Collection<E>
中的
toArray
AbstractCollection<E>
中的
toArray
a
- 用来存储队列元素的数组(如果它足够大);否则,为此分配一个具有相同运行时类型的新数组。
ArrayStoreException
- 如果指定数组的运行时类型不是此队列中每个元素的运行时类型的超类型
NullPointerException
- 如果指定数组为 null
public String toString()
AbstractCollection
复制的描述
String.valueOf(Object)
可以将元素转换成字符串。
AbstractCollection<E>
中的
toString
public void clear()
Collection<E>
中的
clear
AbstractQueue<E>
中的
clear
public int drainTo(Collection<? super E> c)
BlockingQueue
复制的描述
BlockingQueue<E>
中的
drainTo
c
- 接收传输元素的 collection
UnsupportedOperationException
- 如果指定 collection 不支持添加元素
ClassCastException
- 如果此队列元素的类不允许将其添加到指定 collection
NullPointerException
- 如果指定 collection 为 null
IllegalArgumentException
- 如果指定 collection 是此队列,或者此队列元素的某些属性不允许将其添加到指定 collection
public int drainTo(Collection<? super E> c, int maxElements)
BlockingQueue
复制的描述
BlockingQueue<E>
中的
drainTo
c
- 接收传输元素的 collection
maxElements
- 传输元素的最大数量
UnsupportedOperationException
- 如果指定 collection 不支持添加元素
ClassCastException
- 如果此队列元素的类不允许将其添加到指定 collection
NullPointerException
- 如果指定 collection 为 null
IllegalArgumentException
- 如果指定 collection 是此队列,或者此队列元素的某些属性不允许将其添加到指定 collection
public Iterator<E> iterator()
ConcurrentModificationException
,并且确保可遍历迭代器构造后所存在的所有元素,并且可能(但并不保证)反映构造后的所有修改。
Iterable<E>
中的
iterator
Collection<E>
中的
iterator
AbstractCollection<E>
中的
iterator