Deque (Java Platform SE 8 )

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

All Superinterfaces:: Collection ， Iterable ， Queue

All Known Subinterfaces:: BlockingDeque

所有已知实现类：: ArrayDeque， ConcurrentLinkedDeque， LinkedBlockingDeque， LinkedList

public interface Deque<E>
extends Queue<E>

支持在两个端插入和去除元素的线性集合。名称deque容器是短暂的“双端队列”通常是明显的“甲板”。最 Deque实现地方没有固定的限制对他们可能包含的元素的数目，但此接口支持容量受限的双端队列以及那些没有固定大小的限制。

该接口定义了在deque两端访问元素的方法。提供了插入、删除和检查元素的方法。这些方法都存在两种形式：一个抛出一个异常，如果操作失败，其他返回一个特殊的价值（无论是null或false，根据操作）。插入操作的后一种形式是专为使用有容量限制Deque实现；在大多数实现中，插入操作不会失败。

上述十二种方法在下表中总结：

Summary of Deque methods
	First Element (Head)		Last Element (Tail)
	Throws exception	Special value	Throws exception	Special value
Insert	`addFirst(e)`	`offerFirst(e)`	`addLast(e)`	`offerLast(e)`
Remove	`removeFirst()`	`pollFirst()`	`removeLast()`	`pollLast()`
Examine	`getFirst()`	`peekFirst()`	`getLast()`	`peekLast()`

这Queue接口扩展接口。当一个deque容器作为一个队列，FIFO（先进先出）的行为的结果。元素添加在deque的结束和开始拆除。该方法继承了Queue接口相当于Deque方法如下表所示：

Comparison of Queue and Deque methods
`Queue` Method	Equivalent `Deque` Method
`add(e)`	`addLast(e)`
`offer(e)`	`offerLast(e)`
`remove()`	`removeFirst()`
`poll()`	`pollFirst()`
`element()`	`getFirst()`
`peek()`	`peekFirst()`

双端队列也可以用作LIFO（后进先出）栈。这个接口应该优先用于遗留Stack类。当一个deque作为栈元素推出该容器的开始。堆栈的方法相当于Deque方法如表所示：

Comparison of Stack and Deque methods
Stack Method	Equivalent `Deque` Method
`push(e)`	`addFirst(e)`
`pop()`	`removeFirst()`
`peek()`	`peekFirst()`

请注意，peek方法同样在deque容器作为队列和栈；在任何情况下，元件从deque开始画。

这个接口提供了消除内部元素的两种方法，removeFirstOccurrence和removeLastOccurrence。

不像List接口，这个接口不提供索引访问元素的支持。

而Deque实现不严格要求禁止空元素的插入，他们强烈鼓励这样做。任何Deque实现允许null元素强烈鼓励不利用插入空值的能力的用户。这是因为null作为一个特殊的返回值的各种方法表明，容器是空的。

Deque实现一般不定义元素的基础版本的equals和hashCode方法，而是继承的基于身份的版本从类Object。

该接口的 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`返回包含指定的元素。
`Iterator<E>`	`descendingIterator()` 返回在反向顺序在deque容器元素的迭代器。
`E`	`element()` 检索，但不删除，这代表的deque队列的头部（换句话说，这个容器的第一个元素）。
`E`	`getFirst()` 检索，但不删除该deque容器的第一个元素。
`E`	`getLast()` 检索，但不删除该队列的最后一个元素。
`Iterator<E>`	`iterator()` 返回以正确的顺序在deque容器元素的迭代器。
`boolean`	`offer(E e)` 插入指定元素为代表的deque队列（换句话说，在这个队列尾）如果可能立即这样做不违反容量限制，还 `true`在成功和 `false`如果没有空间是可用的。
`boolean`	`offerFirst(E e)` 插入指定元素在这个队列前面除非它违背了容量限制。
`boolean`	`offerLast(E e)` 插入指定元素在这个队列最后除非它违背了容量限制。
`E`	`peek()` 检索，但不删除，这代表的deque队列的头部（换句话说，这个容器的第一个元素），或返回 `null`如果队列是空的。
`E`	`peekFirst()` 检索，但不删除该deque容器的第一个元素，或返回 `null`如果队列是空的。
`E`	`peekLast()` 检索，但不删除该队列的最后一个元素，或返回 `null`如果队列是空的。
`E`	`poll()` 检索并移除该deque表示队列的头部（换句话说，这个容器的第一个元素），或返回 `null`如果队列是空的。
`E`	`pollFirst()` 检索并移除此队列的第一个元素，或返回 `null`如果队列是空的。
`E`	`pollLast()` 检索并移除此队列的最后一个元素，或返回 `null`如果队列是空的。
`E`	`pop()` 从这个弹出堆栈队列代表元素。
`void`	`push(E e)` 将一个元素到该deque表示堆栈（换句话说，在这个队列的头）如果可能立即这样做不违反容量限制，抛出一个 `IllegalStateException`如果没有空间是可用的。
`E`	`remove()` 检索并移除该deque表示队列的头部（换句话说，这个容器的第一个元素）。
`boolean`	`remove(Object o)` 删除第一个出现的指定元素从这个队列。
`E`	`removeFirst()` 检索并移除此队列的第一个元素。
`boolean`	`removeFirstOccurrence(Object o)` 删除第一个出现的指定元素从这个队列。
`E`	`removeLast()` 检索并移除此队列的最后一个元素。
`boolean`	`removeLastOccurrence(Object o)` 移除指定元素的最后出现从这个队列。
`int`	`size()` 返回该容器元素的数量。

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(E)。
    
    参数
    
    e -元素添加
    
    异常
    
    IllegalStateException -如果元素不能被添加在这个时候由于产能限制
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null，这的确不允许null元素
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - addLast
```
void addLast(E e)
```
    插入指定元素在这个队列的最后如果可能立即这样做不违反容量限制，抛出一个 IllegalStateException如果没有空间是可用的。使用容量限制容器时，它是通常最好使用方法 offerLast(E)。
    这种方法相当于add(E)。
    
    参数
    
    e -元素添加
    
    异常
    
    IllegalStateException -如果元素不能被添加在这个时候由于产能限制
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null，这的确不允许null元素
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - offerFirst
```
boolean offerFirst(E e)
```
    插入指定元素在这个队列前面除非它违背了容量限制。使用容量限制队列时，这种方法是最好的 addFirst(E)方法，可不能只通过抛出异常，插入一个元素。
    
    参数
    
    e -元素添加
    
    结果
    
    true如果元素被添加到这个容器，其他 false
    
    异常
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null，这的确不允许null元素
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - offerLast
```
boolean offerLast(E e)
```
    插入指定元素在这个队列最后除非它违背了容量限制。使用容量限制队列时，这种方法是最好的 addLast(E)方法，可不能只通过抛出异常，插入一个元素。
    
    参数
    
    e -元素添加
    
    结果
    
    true如果元素被添加到这个容器，其他 false
    
    异常
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null，这的确不允许null元素
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - removeFirst
```
E removeFirst()
```
    检索并移除此队列的第一个元素。这种方法不同于 pollFirst仅在于它抛出一个异常，如果这个容器是空的。
    
    结果
    
    这个队列头
    
    异常
    
    NoSuchElementException -如果这队列是空的
  - removeLast
```
E removeLast()
```
    检索并移除此队列的最后一个元素。这种方法不同于 pollLast仅在于它抛出一个异常，如果这个容器是空的。
    
    结果
    
    这个队列的尾部
    
    异常
    
    NoSuchElementException -如果这队列是空的
  - pollFirst
```
E pollFirst()
```
    检索并移除此队列的第一个元素，或返回 null如果队列是空的。
    
    结果
    
    这个队列的头，或 null如果队列是空的
  - pollLast
```
E pollLast()
```
    检索并移除此队列的最后一个元素，或返回 null如果队列是空的。
    
    结果
    
    这个队列尾，或 null如果队列是空的
  - getFirst
```
E getFirst()
```
    检索，但不删除该deque容器的第一个元素。这种方法不同于 peekFirst仅在于它抛出一个异常，如果这个容器是空的。
    
    结果
    
    这个队列头
    
    异常
    
    NoSuchElementException -如果这队列是空的
  - getLast
```
E getLast()
```
    检索，但不删除该队列的最后一个元素。这种方法不同于 peekLast仅在于它抛出一个异常，如果这个容器是空的。
    
    结果
    
    这个队列的尾部
    
    异常
    
    NoSuchElementException -如果这队列是空的
  - peekFirst
```
E peekFirst()
```
    检索，但不删除该deque容器的第一个元素，或返回 null如果队列是空的。
    
    结果
    
    这个队列的头，或 null如果队列是空的
  - peekLast
```
E peekLast()
```
    检索，但不删除该队列的最后一个元素，或返回 null如果队列是空的。
    
    结果
    
    这个队列尾，或 null如果队列是空的
  - removeFirstOccurrence
```
boolean removeFirstOccurrence(Object o)
```
    删除第一个出现的指定元素从这个队列。如果队列不包含元素，它是不变的。更正式，删除第一个元素 e这样 (o==null ? e==null : o.equals(e))（如果这种元素的存在）。如果这两 true返回包含指定元素（或等价地，如果调用的结果这的确改变了）。
    
    参数
    
    o元要从队列移除，如果存在
    
    结果
    
    true如果元素是作为一个结果，这叫删除
    
    异常
    
    ClassCastException如果指定元素的类是不兼容的（这两 optional）
    
    NullPointerException -如果指定元素为null，这的确不允许null元素（ optional）
  - removeLastOccurrence
```
boolean removeLastOccurrence(Object o)
```
    移除指定元素的最后出现从这个队列。如果队列不包含元素，它是不变的。更正式地说，这样 (o==null ? e==null : o.equals(e))移除最后一个元素 e（如果这样一个元素存在）。如果这两 true返回包含指定元素（或等价地，如果调用的结果这的确改变了）。
    
    参数
    
    o元要从队列移除，如果存在
    
    结果
    
    true如果元素是作为一个结果，这叫删除
    
    异常
    
    ClassCastException如果指定元素的类是不兼容的（这两 optional）
    
    NullPointerException -如果指定元素为null，这的确不允许null元素（ optional）
  - add
```
boolean add(E e)
```
    插入指定元素为代表的deque队列（换句话说，在这个队列尾）如果可能立即这样做不违反容量限制，还 true成功后抛出 IllegalStateException如果没有空间是可用的。使用容量限制容器时，它是通常最好使用 offer。
    这种方法相当于addLast(E)。
    
    Specified by:
    
    add 接口 Collection<E>
    
    Specified by:
    
    add 接口 Queue<E>
    
    参数
    
    e -元素添加
    
    结果
    
    true（由 Collection.add(E)指定）
    
    异常
    
    IllegalStateException -如果元素不能被添加在这个时候由于产能限制
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null，这的确不允许null元素
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - offer
```
boolean offer(E e)
```
    插入指定元素为代表的deque队列（换句话说，在这个队列尾）如果可能立即这样做不违反容量限制，还 true在成功和 false如果没有空间是可用的。使用容量限制队列时，这种方法是最好的 add(E)方法，可不能只通过抛出异常，插入一个元素。
    这种方法相当于offerLast(E)。
    
    Specified by:
    
    offer 接口 Queue<E>
    
    参数
    
    e -元素添加
    
    结果
    
    true如果元素被添加到这个容器，其他 false
    
    异常
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null，这的确不允许null元素
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - remove
```
E remove()
```
    检索并移除该deque表示队列的头部（换句话说，这个容器的第一个元素）。这种方法不同于 poll仅在于它抛出一个异常，如果这个容器是空的。
    这种方法相当于removeFirst()。
    
    Specified by:
    
    remove 接口 Queue<E>
    
    结果
    
    这代表的deque队列的头部
    
    异常
    
    NoSuchElementException -如果这队列是空的
  - poll
```
E poll()
```
    检索并移除该deque表示队列的头部（换句话说，这个容器的第一个元素），或返回 null如果队列是空的。
    这种方法相当于pollFirst()。
    
    Specified by:
    
    poll 接口 Queue<E>
    
    结果
    
    这个容器的第一个元素，或 null如果队列是空的
  - element
```
E element()
```
    检索，但不删除，这代表的deque队列的头部（换句话说，这个容器的第一个元素）。这种方法不同于 peek仅在于它抛出一个异常，如果这个容器是空的。
    这种方法相当于getFirst()。
    
    Specified by:
    
    element 接口 Queue<E>
    
    结果
    
    这代表的deque队列的头部
    
    异常
    
    NoSuchElementException -如果这队列是空的
  - peek
```
E peek()
```
    检索，但不删除，这代表的deque队列的头部（换句话说，这个容器的第一个元素），或返回 null如果队列是空的。
    这种方法相当于peekFirst()。
    
    Specified by:
    
    peek 接口 Queue<E>
    
    结果
    
    这代表的队列队列的头部，或 null如果队列是空的
  - push
```
void push(E e)
```
    将一个元素到该deque表示堆栈（换句话说，在这个队列的头）如果可能立即这样做不违反容量限制，抛出一个 IllegalStateException如果没有空间是可用的。
    这种方法相当于addFirst(E)。
    
    参数
    
    e -元推
    
    异常
    
    IllegalStateException -如果元素不能被添加在这个时候由于产能限制
    
    ClassCastException -如果指定元素类型阻止其加入队列
    
    NullPointerException -如果指定元素为null，这的确不允许null元素
    
    IllegalArgumentException -如果指定元素的一些特性阻止其加入队列
  - pop
```
E pop()
```
    从这个弹出堆栈队列代表元素。换句话说，移除并返回该deque容器的第一个元素。
    这种方法相当于removeFirst()。
    
    结果
    
    在这个队列前面的元素（这是由该deque表示栈顶）
    
    异常
    
    NoSuchElementException -如果这队列是空的
  - remove
```
boolean remove(Object o)
```
    删除第一个出现的指定元素从这个队列。如果队列不包含元素，它是不变的。更正式，删除， (o==null ? e==null : o.equals(e))第一单元 e（如果这样一个元素存在）。如果这两 true返回包含指定元素（或等价地，如果调用的结果这的确改变了）。
    这种方法相当于removeFirstOccurrence(Object)。
    
    Specified by:
    
    remove 接口 Collection<E>
    
    参数
    
    o元要从队列移除，如果存在
    
    结果
    
    true如果元素是作为一个结果，这叫删除
    
    异常
    
    ClassCastException如果指定元素的类是不兼容的（这两 optional）
    
    NullPointerException -如果指定元素为null，这的确不允许null元素（ optional）
  - contains
```
boolean contains(Object o)
```
    如果这两 true返回包含指定的元素。更正式地说，返回 true当且仅当这个容器包含至少一个元素 e这样 (o==null ? e==null : o.equals(e))。
    
    Specified by:
    
    contains 接口 Collection<E>
    
    参数
    
    o -这的确存在的元素进行测试
    
    结果
    
    如果这两 true包含指定的元素
    
    异常
    
    ClassCastException -如果指定元素的类型与此队列不相容（ optional）
    
    NullPointerException -如果指定元素为null，这的确不允许null元素（ optional）
  - size
```
int size()
```
    返回该容器元素的数量。
    
    Specified by:
    
    size 接口 Collection<E>
    
    结果
    
    在这个容器元素的数量
  - iterator
```
Iterator<E> iterator()
```
    返回以正确的顺序在deque容器元素的迭代器。元素将从第一（头）返回到最后（尾）。
    
    Specified by:
    
    iterator 接口 Collection<E>
    
    Specified by:
    
    iterator 接口 Iterable<E>
    
    结果
    
    在正确的顺序在deque容器元素的迭代器
  - descendingIterator
```
Iterator<E> descendingIterator()
```
    返回在反向顺序在deque容器元素的迭代器。元素将从最后（尾部）返回到第一个（头）。
    
    结果
    
    在相反的顺序在deque容器元素的迭代器

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 Deque<E>

方法摘要

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

方法详细信息

addFirst

addLast

offerFirst

offerLast

removeFirst

removeLast

pollFirst

pollLast

getFirst

getLast

peekFirst

peekLast

removeFirstOccurrence

removeLastOccurrence

add

offer

remove

poll

element

peek

push

pop

remove

contains

size

iterator

descendingIterator