BlockingDeque (Java Platform SE 8 )

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

All Superinterfaces:: BlockingQueue ， Collection ， Deque ， Iterable ， Queue

所有已知实现类：: LinkedBlockingDeque

public interface BlockingDeque<E>
extends BlockingQueue<E>, Deque<E>

一，另外支持阻塞操作等待队列非空的检索成为一个元素时 Deque，等待空间变得可用时在deque容器存储元件。

BlockingDeque方法有四种形式，不同的处理操作，不能立即满足的方式，但可以满足在未来的某一时刻：一个抛出一个异常，第二返回一个特殊值（或null或false，取决于操作），第三块的当前线程直到操作成功，只为一个给定的时间限制在放弃之前的第四块。这些方法汇总在下表中：

Summary of BlockingDeque methods
First Element (Head)
	Throws exception	Special value	Blocks	Times out
Insert	`addFirst(e)`	`offerFirst(e)`	`putFirst(e)`	`offerFirst(e, time, unit)`
Remove	`removeFirst()`	`pollFirst()`	`takeFirst()`	`pollFirst(time, unit)`
Examine	`getFirst()`	`peekFirst()`	not applicable	not applicable
Last Element (Tail)
	Throws exception	Special value	Blocks	Times out
Insert	`addLast(e)`	`offerLast(e)`	`putLast(e)`	`offerLast(e, time, unit)`
Remove	`removeLast()`	`pollLast()`	`takeLast()`	`pollLast(time, unit)`
Examine	`getLast()`	`peekLast()`	not applicable	not applicable

像任何BlockingQueue，一BlockingDeque是线程安全的，不允许null元素，可能（或不可能）有能力约束。

一个BlockingDeque实施可直接使用FIFO作为BlockingQueue。方法继承了BlockingQueue接口相当于BlockingDeque方法如下表所示：

Comparison of BlockingQueue and BlockingDeque methods
`BlockingQueue` Method	Equivalent `BlockingDeque` Method
Insert
`add(e)`	`addLast(e)`
`offer(e)`	`offerLast(e)`
`put(e)`	`putLast(e)`
`offer(e, time, unit)`	`offerLast(e, time, unit)`
Remove
`remove()`	`removeFirst()`
`poll()`	`pollFirst()`
`take()`	`takeFirst()`
`poll(time, unit)`	`pollFirst(time, unit)`
Examine
`element()`	`getFirst()`
`peek()`	`peekFirst()`

内存一致性效果：与其他并发集合，在将对象放入一个BlockingDeque happen-before行动从另一个线程的BlockingDeque元素的访问和去除之前的线程的行为。

该接口的 Java Collections Framework成员。

从以下版本开始：: 一点六

方法摘要

所有方法接口方法抽象方法
Modifier and Type	Method and Description
`boolean`	`add(E e)` 插入指定元素为代表的deque队列（换句话说，在这个队列尾）如果可能立即这样做不违反容量限制，还 `true`成功后抛出 `IllegalStateException`如果没有空间是可用的。
`void`	`addFirst(E e)` 插入指定元素在队列前面是否有可能立即这样做不违反容量限制，抛出一个 `IllegalStateException`如果没有空间是可用的。
`void`	`addLast(E e)` 插入指定元素在这个队列的最后如果可能立即这样做不违反容量限制，抛出一个 `IllegalStateException`如果没有空间是可用的。
`boolean`	`contains(Object o)` 如果这两 `true`返回包含指定的元素。
`E`	`element()` 检索，但不删除，这代表的deque队列的头部（换句话说，这个容器的第一个元素）。
`Iterator<E>`	`iterator()` 返回以正确的顺序在deque容器元素的迭代器。
`boolean`	`offer(E e)` 插入指定元素为代表的deque队列（换句话说，在这个队列尾）如果可能立即这样做不违反容量限制，还 `true`在成功和 `false`如果没有空间是可用的。
`boolean`	`offer(E e, long timeout, TimeUnit unit)` 插入指定元素为代表的deque队列（换句话说，在这个队列的尾部），等待到指定的等待时间，如果空间成为必要。
`boolean`	`offerFirst(E e)` 插入指定元素在队列前面是否有可能立即这样做不违反容量限制，还 `true`在成功和 `false`如果没有空间是可用的。
`boolean`	`offerFirst(E e, long timeout, TimeUnit unit)` 在这个队列的前面插入指定元素，等待到指定的等待时间，如果空间成为必要。
`boolean`	`offerLast(E e)` 插入指定元素在这个队列的最后如果可能立即这样做不违反容量限制，还 `true`在成功和 `false`如果没有空间是可用的。
`boolean`	`offerLast(E e, long timeout, TimeUnit unit)` 在这个队列的末尾插入指定元素，等待到指定的等待时间，如果空间成为必要。
`E`	`peek()` 检索，但不删除，这代表的deque队列的头部（换句话说，这个容器的第一个元素），或返回 `null`如果队列是空的。
`E`	`poll()` 检索并移除该deque表示队列的头部（换句话说，这个容器的第一个元素），或返回 `null`如果队列是空的。
`E`	`poll(long timeout, TimeUnit unit)` 检索并移除该deque表示队列的头部（换句话说，这个容器的第一个元素），等待到指定的等待时间，如果一个元素成为必要。
`E`	`pollFirst(long timeout, TimeUnit unit)` 检索并移除此队列的第一个元素，等待到指定的等待时间，如果一个元素成为必要。
`E`	`pollLast(long timeout, TimeUnit unit)` 检索并移除此队列的最后一个元素，等待到指定的等待时间，如果一个元素成为必要。
`void`	`push(E e)` 将一个元素到该deque表示堆栈（换句话说，在这个队列的头）如果可能立即这样做不违反容量限制，抛出一个 `IllegalStateException`如果没有空间是可用的。
`void`	`put(E e)` 插入指定元素为代表的deque队列（换句话说，在这个队列的尾部），如果空间成为提供必要的等待。
`void`	`putFirst(E e)` 在这个队列的前面插入指定元素，如果空间成为提供必要的等待。
`void`	`putLast(E e)` 在这个队列的末尾插入指定元素，如果空间成为提供必要的等待。
`E`	`remove()` 检索并移除该deque表示队列的头部（换句话说，这个容器的第一个元素）。
`boolean`	`remove(Object o)` 删除第一个出现的指定元素从这个队列。
`boolean`	`removeFirstOccurrence(Object o)` 删除第一个出现的指定元素从这个队列。
`boolean`	`removeLastOccurrence(Object o)` 移除指定元素的最后出现从这个队列。
`int`	`size()` 返回该容器元素的数量。
`E`	`take()` 检索并移除该deque表示队列的头部（换句话说，这个容器的第一个元素），必要时可用等待直到元。
`E`	`takeFirst()` 检索并移除此队列的第一个元素，如果有必要，直到一个元素可用等。
`E`	`takeLast()` 检索并移除此队列的最后一个元素，如果有必要，直到一个元素可用等。

Methods inherited from interface java.util.concurrent.BlockingQueue
drainTo, drainTo, remainingCapacity

Methods inherited from interface java.util.Deque
descendingIterator, getFirst, getLast, peekFirst, peekLast, pollFirst, pollLast, pop, removeFirst, removeLast

Methods inherited from interface java.util.Collection
addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable
forEach

- 方法详细信息
  - addFirst
```
void addFirst(E e)
```
    插入指定元素在队列前面是否有可能立即这样做不违反容量限制，抛出一个 IllegalStateException如果没有空间是可用的。使用容量限制容器时，它是通常最好使用 offerFirst。
    
    Specified by:
    
    addFirst 接口 Deque<E>
    
    参数
    
    e -元素添加
    
    异常
    
    IllegalStateException -如果元素不能被添加在这个时候由于产能限制
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - addLast
```
void addLast(E e)
```
    插入指定元素在这个队列的最后如果可能立即这样做不违反容量限制，抛出一个 IllegalStateException如果没有空间是可用的。使用容量限制容器时，它是通常最好使用 offerLast。
    
    Specified by:
    
    addLast 接口 Deque<E>
    
    参数
    
    e -元素添加
    
    异常
    
    IllegalStateException -如果元素不能被添加在这个时候由于产能限制
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - offerFirst
```
boolean offerFirst(E e)
```
    插入指定元素在队列前面是否有可能立即这样做不违反容量限制，还 true在成功和 false如果没有空间是可用的。使用容量限制队列时，这种方法是最好的 addFirst方法，可不能只通过抛出异常，插入一个元素。
    
    Specified by:
    
    offerFirst 接口 Deque<E>
    
    参数
    
    e -元素添加
    
    结果
    
    true如果元素被添加到这个容器，其他 false
    
    异常
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - offerLast
```
boolean offerLast(E e)
```
    插入指定元素在这个队列的最后如果可能立即这样做不违反容量限制，还 true在成功和 false如果没有空间是可用的。使用容量限制队列时，这种方法是最好的 addLast方法，可不能只通过抛出异常，插入一个元素。
    
    Specified by:
    
    offerLast 接口 Deque<E>
    
    参数
    
    e -元素添加
    
    结果
    
    true如果元素被添加到这个容器，其他 false
    
    异常
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - putFirst
```
void putFirst(E e)
       throws InterruptedException
```
    在这个队列的前面插入指定元素，如果空间成为提供必要的等待。
    
    参数
    
    e -元素添加
    
    异常
    
    InterruptedException如果中断等待
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - putLast
```
void putLast(E e)
      throws InterruptedException
```
    在这个队列的末尾插入指定元素，如果空间成为提供必要的等待。
    
    参数
    
    e -元素添加
    
    异常
    
    InterruptedException如果中断等待
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - offerFirst
```
boolean offerFirst(E e,
                   long timeout,
                   TimeUnit unit)
            throws InterruptedException
```
    在这个队列的前面插入指定元素，等待到指定的等待时间，如果空间成为必要。
    
    参数
    
    e -元素添加
    
    timeout -多久才放弃等待，在单位 unit
    
    unit - TimeUnit确定如何解释 timeout参数
    
    结果
    
    true如果成功，或 false如果指定的等待时间过去之前可用空间
    
    异常
    
    InterruptedException如果中断等待
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - offerLast
```
boolean offerLast(E e,
                  long timeout,
                  TimeUnit unit)
           throws InterruptedException
```
    在这个队列的末尾插入指定元素，等待到指定的等待时间，如果空间成为必要。
    
    参数
    
    e -元素添加
    
    timeout -多久才放弃等待，在单位 unit
    
    unit - TimeUnit确定如何解释 timeout参数
    
    结果
    
    true如果成功，或 false如果指定的等待时间过去之前可用空间
    
    异常
    
    InterruptedException如果中断等待
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - takeFirst
```
E takeFirst()
     throws InterruptedException
```
    检索并移除此队列的第一个元素，如果有必要，直到一个元素可用等。
    
    结果
    
    这个队列头
    
    异常
    
    InterruptedException如果中断等待
  - takeLast
```
E takeLast()
    throws InterruptedException
```
    检索并移除此队列的最后一个元素，如果有必要，直到一个元素可用等。
    
    结果
    
    这个队列的尾部
    
    异常
    
    InterruptedException如果中断等待
  - pollFirst
```
E pollFirst(long timeout,
            TimeUnit unit)
     throws InterruptedException
```
    检索并移除此队列的第一个元素，等待到指定的等待时间，如果一个元素成为必要。
    
    参数
    
    timeout -多久才放弃等待，在单位 unit
    
    unit - TimeUnit确定如何解释 timeout参数
    
    结果
    
    这个队列的头部，或 null如果指定的等待时间过去之前一个元素是可用的
    
    异常
    
    InterruptedException如果中断等待
  - pollLast
```
E pollLast(long timeout,
           TimeUnit unit)
    throws InterruptedException
```
    检索并移除此队列的最后一个元素，等待到指定的等待时间，如果一个元素成为必要。
    
    参数
    
    timeout -多久才放弃等待，在单位 unit
    
    unit - TimeUnit确定如何解释 timeout参数
    
    结果
    
    这个队列的尾部，或 null如果指定的等待时间过去之前一个元素是可用的
    
    异常
    
    InterruptedException如果中断等待
  - removeFirstOccurrence
```
boolean removeFirstOccurrence(Object o)
```
    删除第一个出现的指定元素从这个队列。如果队列不包含元素，它是不变的。更正式，删除， o.equals(e)第一单元 e（如果这样一个元素存在）。如果这两 true返回包含指定元素（或等价地，如果调用的结果这的确改变了）。
    
    Specified by:
    
    removeFirstOccurrence 接口 Deque<E>
    
    参数
    
    o元要从队列移除，如果存在
    
    结果
    
    true如果元素是作为一个结果，这叫删除
    
    异常
    
    ClassCastException如果指定元素的类是不兼容的（这两 optional）
    
    NullPointerException -如果指定元素为null（ optional）
  - removeLastOccurrence
```
boolean removeLastOccurrence(Object o)
```
    移除指定元素的最后出现从这个队列。如果队列不包含元素，它是不变的。更正式地说，这样 o.equals(e)移除最后一个元素 e（如果这样一个元素存在）。如果这两 true返回包含指定元素（或等价地，如果调用的结果这的确改变了）。
    
    Specified by:
    
    removeLastOccurrence 接口 Deque<E>
    
    参数
    
    o元要从队列移除，如果存在
    
    结果
    
    true如果元素是作为一个结果，这叫删除
    
    异常
    
    ClassCastException如果指定元素的类是不兼容的（这两 optional）
    
    NullPointerException -如果指定元素为null（ optional）
  - add
```
boolean add(E e)
```
    插入指定元素为代表的deque队列（换句话说，在这个队列尾）如果可能立即这样做不违反容量限制，还 true成功后抛出 IllegalStateException如果没有空间是可用的。使用容量限制容器时，它是通常最好使用 offer。
    这种方法相当于addLast。
    
    Specified by:
    
    add 接口 BlockingQueue<E>
    
    Specified by:
    
    add 接口 Collection<E>
    
    Specified by:
    
    add 接口 Deque<E>
    
    Specified by:
    
    add 接口 Queue<E>
    
    参数
    
    e -元素添加
    
    结果
    
    true（由 Collection.add(E)指定）
    
    异常
    
    IllegalStateException -如果元素不能被添加在这个时候由于产能限制
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - offer
```
boolean offer(E e)
```
    插入指定元素为代表的deque队列（换句话说，在这个队列尾）如果可能立即这样做不违反容量限制，还 true在成功和 false如果没有空间是可用的。使用容量限制队列时，这种方法是最好的 add(E)方法，可不能只通过抛出异常，插入一个元素。
    这种方法相当于offerLast。
    
    Specified by:
    
    offer 接口 BlockingQueue<E>
    
    Specified by:
    
    offer 接口 Deque<E>
    
    Specified by:
    
    offer 接口 Queue<E>
    
    参数
    
    e -元素添加
    
    结果
    
    true如果元素被添加到这个队列，否则 false
    
    异常
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - put
```
void put(E e)
  throws InterruptedException
```
    插入指定元素为代表的deque队列（换句话说，在这个队列的尾部），如果空间成为提供必要的等待。
    这种方法相当于putLast。
    
    Specified by:
    
    put 接口 BlockingQueue<E>
    
    参数
    
    e -元素添加
    
    异常
    
    InterruptedException如果中断等待
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - offer
```
boolean offer(E e,
              long timeout,
              TimeUnit unit)
       throws InterruptedException
```
    插入指定元素为代表的deque队列（换句话说，在这个队列的尾部），等待到指定的等待时间，如果空间成为必要。
    这种方法相当于offerLast。
    
    Specified by:
    
    offer 接口 BlockingQueue<E>
    
    参数
    
    e -元素添加
    
    timeout -多久才放弃等待，在单位 unit
    
    unit - TimeUnit确定如何解释 timeout参数
    
    结果
    
    true如果元素被添加到这个容器，其他 false
    
    异常
    
    InterruptedException如果中断等待
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - remove
```
E remove()
```
    检索并移除该deque表示队列的头部（换句话说，这个容器的第一个元素）。这种方法不同于 poll仅在于它抛出一个异常，如果这个容器是空的。
    这种方法相当于removeFirst。
    
    Specified by:
    
    remove 接口 Deque<E>
    
    Specified by:
    
    remove 接口 Queue<E>
    
    结果
    
    这代表的deque队列的头部
    
    异常
    
    NoSuchElementException -如果这队列是空的
  - poll
```
E poll()
```
    检索并移除该deque表示队列的头部（换句话说，这个容器的第一个元素），或返回 null如果队列是空的。
    这种方法相当于Deque.pollFirst()。
    
    Specified by:
    
    poll 接口 Deque<E>
    
    Specified by:
    
    poll 接口 Queue<E>
    
    结果
    
    这个队列的头，或 null如果队列是空的
  - take
```
E take()
throws InterruptedException
```
    检索并移除该deque表示队列的头部（换句话说，这个容器的第一个元素），必要时可用等待直到元。
    这种方法相当于takeFirst。
    
    Specified by:
    
    take 接口 BlockingQueue<E>
    
    结果
    
    这个队列头
    
    异常
    
    InterruptedException如果中断等待
  - poll
```
E poll(long timeout,
       TimeUnit unit)
throws InterruptedException
```
    检索并移除该deque表示队列的头部（换句话说，这个容器的第一个元素），等待到指定的等待时间，如果一个元素成为必要。
    这种方法相当于pollFirst。
    
    Specified by:
    
    poll 接口 BlockingQueue<E>
    
    参数
    
    timeout -多久才放弃等待，在单位 unit
    
    unit - TimeUnit确定如何解释 timeout参数
    
    结果
    
    这个队列的头部，或 null如果指定的等待时间过去之前一个元素是可用的
    
    异常
    
    InterruptedException如果中断等待
  - element
```
E element()
```
    检索，但不删除，这代表的deque队列的头部（换句话说，这个容器的第一个元素）。这种方法不同于 peek仅在于它抛出一个异常，如果这个容器是空的。
    这种方法相当于getFirst。
    
    Specified by:
    
    element 接口 Deque<E>
    
    Specified by:
    
    element 接口 Queue<E>
    
    结果
    
    这个队列头
    
    异常
    
    NoSuchElementException -如果这队列是空的
  - peek
```
E peek()
```
    检索，但不删除，这代表的deque队列的头部（换句话说，这个容器的第一个元素），或返回 null如果队列是空的。
    这种方法相当于peekFirst。
    
    Specified by:
    
    peek 接口 Deque<E>
    
    Specified by:
    
    peek 接口 Queue<E>
    
    结果
    
    这个队列的头，或 null如果队列是空的
  - remove
```
boolean remove(Object o)
```
    删除第一个出现的指定元素从这个队列。如果队列不包含元素，它是不变的。更正式，删除， o.equals(e)第一单元 e（如果这样一个元素存在）。如果这两 true返回包含指定元素（或等价地，如果调用的结果这的确改变了）。
    这种方法相当于removeFirstOccurrence。
    
    Specified by:
    
    remove 接口 BlockingQueue<E>
    
    Specified by:
    
    remove 接口 Collection<E>
    
    Specified by:
    
    remove 接口 Deque<E>
    
    参数
    
    o元要从队列移除，如果存在
    
    结果
    
    true如果调用的结果这的确改变了
    
    异常
    
    ClassCastException如果指定元素的类是不兼容的（这两 optional）
    
    NullPointerException -如果指定元素为null（ optional）
  - contains
```
boolean contains(Object o)
```
    如果这两 true返回包含指定的元素。更正式地说，返回 true当且仅当这个容器包含至少一个元素 e这样 o.equals(e)。
    
    Specified by:
    
    contains 接口 BlockingQueue<E>
    
    Specified by:
    
    contains 接口 Collection<E>
    
    Specified by:
    
    contains 接口 Deque<E>
    
    参数
    
    o对象进行检查在deque容器
    
    结果
    
    如果这两 true包含指定的元素
    
    异常
    
    ClassCastException如果指定元素的类是不兼容的（这两 optional）
    
    NullPointerException -如果指定元素为null（ optional）
  - size
```
int size()
```
    返回该容器元素的数量。
    
    Specified by:
    
    size 接口 Collection<E>
    
    Specified by:
    
    size 接口 Deque<E>
    
    结果
    
    在这个容器元素的数量
  - iterator
```
Iterator<E> iterator()
```
    返回以正确的顺序在deque容器元素的迭代器。元素将从第一（头）返回到最后（尾）。
    
    Specified by:
    
    iterator 接口 Collection<E>
    
    Specified by:
    
    iterator 接口 Deque<E>
    
    Specified by:
    
    iterator 接口 Iterable<E>
    
    结果
    
    在正确的顺序在deque容器元素的迭代器
  - push
```
void push(E e)
```
    将一个元素到该deque表示堆栈（换句话说，在这个队列的头）如果可能立即这样做不违反容量限制，抛出一个 IllegalStateException如果没有空间是可用的。
    这种方法相当于addFirst。
    
    Specified by:
    
    push 接口 Deque<E>
    
    参数
    
    e -元推
    
    异常
    
    IllegalStateException -如果元素不能被添加在这个时候由于产能限制
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Interface BlockingDeque<E>

方法摘要

Methods inherited from interface java.util.concurrent.BlockingQueue

Methods inherited from interface java.util.Deque

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

方法详细信息

addFirst

addLast

offerFirst

offerLast

putFirst

putLast

offerFirst

offerLast

takeFirst

takeLast

pollFirst

pollLast

removeFirstOccurrence

removeLastOccurrence

add

offer

put

offer

remove

poll

take

poll

element

peek

remove

contains

size

iterator

push