E
- 此 collection 中保存的元素类型
public interface Deque<E>
一个线性 collection,支持在两端插入和移除元素。名称 deque 是“double ended queue(双端队列)”的缩写,通常读为“deck”。大多数 Deque 实现对于它们能够包含的元素数没有固定限制,但此接口既支持有容量限制的双端队列,也支持没有固定大小限制的双端队列。
此接口定义在双端队列两端访问元素的方法。提供插入、移除和检查元素的方法。每种方法都存在两种形式:一种形式在操作失败时抛出异常,另一种形式返回一个特殊值(null 或 false,具体取决于操作)。插入操作的后一种形式是专为使用有容量限制的 Deque 实现设计的;在大多数实现中,插入操作不能失败。
下表总结了上述 12 种方法:
第一个元素(头部) | 最后一个元素(尾部) | |||
抛出异常 | 特殊值 | 抛出异常 | 特殊值 | |
插入 | addFirst(e) |
offerFirst(e) |
addLast(e) |
offerLast(e) |
移除 | removeFirst() |
pollFirst() |
removeLast() |
pollLast() |
检查 | getFirst() |
peekFirst() |
getLast() |
peekLast() |
此接口扩展了 Queue
接口。在将双端队列用作队列时,将得到 FIFO(先进先出)行为。将元素添加到双端队列的末尾,从双端队列的开头移除元素。从 Queue 接口继承的方法完全等效于 Deque 方法,如下表所示:
Queue 方法 | 等效 Deque 方法 |
add(e) |
addLast(e) |
offer(e) |
offerLast(e) |
remove() |
removeFirst() |
poll() |
pollFirst() |
element() |
getFirst() |
peek() |
peekFirst() |
双端队列也可用作 LIFO(后进先出)堆栈。应优先使用此接口而不是遗留 Stack
类。在将双端队列用作堆栈时,元素被推入双端队列的开头并从双端队列开头弹出。堆栈方法完全等效于 Deque 方法,如下表所示:
堆栈方法 | 等效 Deque 方法 |
push(e) |
addFirst(e) |
pop() |
removeFirst() |
peek() |
peekFirst() |
注意,在将双端队列用作队列或堆栈时,peek
方法同样正常工作;无论哪种情况下,都从双端队列的开头抽取元素。
此接口提供了两种移除内部元素的方法:removeFirstOccurrence
和 removeLastOccurrence
。
与 List
接口不同,此接口不支持通过索引访问元素。
虽然 Deque 实现没有严格要求禁止插入 null 元素,但建议最好这样做。建议任何事实上允许 null 元素的 Deque 实现用户最好不 要利用插入 null 的功能。这是因为各种方法会将 null 用作特殊的返回值来指示双端队列为空。
Deque 实现通常不定义基于元素的 equals 和 hashCode 方法,而是从 Object 类继承基于身份的 equals 和 hashCode 方法。
此接口是 Java Collections Framework 的成员。
方法摘要 | |
---|---|
boolean |
add(E e) 将指定元素插入此双端队列所表示的队列(换句话说,此双端队列的尾部),如果可以直接这样做而不违反容量限制的话;如果成功,则返回 true,如果当前没有可用空间,则抛出 IllegalStateException。 |
void |
addFirst(E e) 将指定元素插入此双端队列的开头(如果可以直接这样做而不违反容量限制)。 |
void |
addLast(E e) 将指定元素插入此双端队列的末尾(如果可以直接这样做而不违反容量限制)。 |
boolean |
contains(Object o) 如果此双端队列包含指定元素,则返回 true。 |
Iterator<E> |
descendingIterator() 返回以逆向顺序在此双端队列的元素上进行迭代的迭代器。 |
E |
element() 获取,但不移除此双端队列所表示的队列的头部(换句话说,此双端队列的第一个元素)。 |
E |
getFirst() 获取,但不移除此双端队列的第一个元素。 |
E |
getLast() 获取,但不移除此双端队列的最后一个元素。 |
Iterator<E> |
iterator() 返回以恰当顺序在此双端队列的元素上进行迭代的迭代器。 |
boolean |
offer(E e) 将指定元素插入此双端队列所表示的队列(换句话说,此双端队列的尾部),如果可以直接这样做而不违反容量限制的话;如果成功,则返回 true,如果当前没有可用的空间,则返回 false。 |
boolean |
offerFirst(E e) 在不违反容量限制的情况下,将指定的元素插入此双端队列的开头。 |
boolean |
offerLast(E e) 在不违反容量限制的情况下,将指定的元素插入此双端队列的末尾。 |
E |
peek() 获取,但不移除此双端队列所表示的队列的头部(换句话说,此双端队列的第一个元素);如果此双端队列为空,则返回 null。 |
E |
peekFirst() 获取,但不移除此双端队列的第一个元素;如果此双端队列为空,则返回 null。 |
E |
peekLast() 获取,但不移除此双端队列的最后一个元素;如果此双端队列为空,则返回 null。 |
E |
poll() 获取并移除此双端队列所表示的队列的头部(换句话说,此双端队列的第一个元素);如果此双端队列为空,则返回 null。 |
E |
pollFirst() 获取并移除此双端队列的第一个元素;如果此双端队列为空,则返回 null。 |
E |
pollLast() 获取并移除此双端队列的最后一个元素;如果此双端队列为空,则返回 null。 |
E |
pop() 从此双端队列所表示的堆栈中弹出一个元素。 |
void |
push(E e) 将一个元素推入此双端队列所表示的堆栈(换句话说,此双端队列的头部),如果可以直接这样做而不违反容量限制的话;如果成功,则返回 true,如果当前没有可用空间,则抛出 IllegalStateException。 |
E |
remove() 获取并移除此双端队列所表示的队列的头部(换句话说,此双端队列的第一个元素)。 |
boolean |
remove(Object o) 从此双端队列中移除第一次出现的指定元素。 |
E |
removeFirst() 获取并移除此双端队列第一个元素。 |
boolean |
removeFirstOccurrence(Object o) 从此双端队列移除第一次出现的指定元素。 |
E |
removeLast() 获取并移除此双端队列的最后一个元素。 |
boolean |
removeLastOccurrence(Object o) 从此双端队列移除最后一次出现的指定元素。 |
int |
size() 返回此双端队列的元素数。 |
从接口 java.util.Collection 继承的方法 |
---|
addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, toArray, toArray |
方法详细信息 |
---|
void addFirst(E e)
offerFirst(E)
方法。
e
- 要添加的元素
IllegalStateException
- 如果此时由于容量限制而无法添加元素
ClassCastException
- 如果指定元素的类不允许将它添加此双端队列
NullPointerException
- 如果指定元素为 null,并且此双端队列不允许 null 元素
IllegalArgumentException
- 如果指定元素的某些属性不允许将它添加到此双端队列
void addLast(E e)
offerLast(E)
方法。
此方法等效于 add(E)
。
e
- 要添加的元素
IllegalStateException
- 如果此时由于容量限制而无法添加元素
ClassCastException
- 如果指定元素的类不允许将它添加此双端队列
NullPointerException
- 如果指定元素为 null,并且此双端队列不允许 null 元素
IllegalArgumentException
- 如果指定元素的某些属性不允许将它添加到此双端队列
boolean offerFirst(E e)
addFirst(E)
方法,后者可能无法插入元素,而只是抛出一个异常。
e
- 要添加的元素
ClassCastException
- 如果指定元素的类不允许将它添加到此双端队列
NullPointerException
- 如果指定元素为 null,并且此双端队列不允许 null 元素
IllegalArgumentException
- 如果指定元素的某些属性不允许将它添加到此双端队列
boolean offerLast(E e)
addLast(E)
方法,后者可能无法插入元素,而只是抛出一个异常。
e
- 要添加的元素
ClassCastException
- 如果指定元素的类不允许将它添加到此双端队列
NullPointerException
- 如果指定元素为 null,并且此双端队列不允许 null 元素
IllegalArgumentException
- 如果指定元素的某些属性不允许将它添加到此双端队列
E removeFirst()
pollFirst
唯一的不同在于:如果此双端队列为空,它将抛出一个异常。
NoSuchElementException
- 如果此双端队列为空
E removeLast()
pollLast
唯一的不同在于:如果此双端队列为空,它将抛出一个异常。
NoSuchElementException
- 如果此双端队列为空
E pollFirst()
E pollLast()
E getFirst()
peekFirst
唯一的不同在于:如果此双端队列为空,它将抛出一个异常。
NoSuchElementException
- 如果此双端队列为空
E getLast()
peekLast
唯一的不同在于:如果此双端队列为空,它将抛出一个异常。
NoSuchElementException
- 如果此双端队列为空
E peekFirst()
E peekLast()
boolean removeFirstOccurrence(Object o)
o
- 要从此双端队列移除的元素(如果存在)
ClassCastException
- 如果指定元素的类与此双端队列不兼容(可选)
NullPointerException
- 如果指定元素为 null,并且此双端队列不允许 null 元素(可选)
boolean removeLastOccurrence(Object o)
o
- 要从此双端队列移除的元素(如果存在)
ClassCastException
- 如果指定元素的类与此双端队列不兼容(可选)
NullPointerException
- 如果指定元素为 null,并且此双端队列不允许 null 元素(可选)
boolean add(E e)
offer
。
此方法等效于 addLast(E)
。
e
- 要添加的元素
Collection.add(E)
的规定)
IllegalStateException
- 如果此时由于容量限制而无法添加元素
ClassCastException
- 如果指定元素的类不允许将它添加到此双端队列
NullPointerException
- 如果指定元素为 null,并且此双端队列不支持 null 元素
IllegalArgumentException
- 如果指定元素的某些属性不允许将它添加到此双端队列
boolean offer(E e)
add(E)
方法,后者可能无法插入元素,而只是抛出一个异常。
此方法等效于 offerLast(E)
。
e
- 要添加的元素
ClassCastException
- 如果指定元素的类不允许将它添加到此双端队列
NullPointerException
- 如果指定元素为 null,并且此双端队列不允许 null 元素
IllegalArgumentException
- 如果指定元素的某些属性不允许将它添加到此双端队列
E remove()
poll
的唯一不同在于:如果此双端队列为空,它将抛出一个异常。
此方法等效于 removeFirst()
。
NoSuchElementException
- 如果此双端队列为空
E poll()
此方法等效于 pollFirst()
。
E element()
peek
唯一的不同在于:如果此双端队列为空,它将抛出一个异常。
此方法等效于 getFirst()
。
NoSuchElementException
- 如果此双端队列为空
E peek()
此方法等效于 peekFirst()
。
void push(E e)
此方法等效于 addFirst(E)
。
e
- 要推入的元素
IllegalStateException
- 如果此时由于容量限制而无法添加元素
ClassCastException
- 如果指定元素的类不允许将它添加此双端队列
NullPointerException
- 如果指定元素为 null,并且此双端队列不允许 null 元素
IllegalArgumentException
- 如果指定元素的某些属性不允许将它添加到此双端队列
E pop()
此方法等效于 removeFirst()
。
NoSuchElementException
- 如果此双端队列为空
boolean remove(Object o)
此方法等效于 removeFirstOccurrence(java.lang.Object)
。
Collection<E>
中的
remove
o
- 要从此双端队列移除的元素(如果存在)
ClassCastException
- 如果指定元素的类与此双端队列不兼容(可选)
NullPointerException
- 如果指定元素为 null,并且此双端队列不允许 null 元素(可选)
boolean contains(Object o)
Collection<E>
中的
contains
o
- 要测试其是否存在于此双端队列的元素
ClassCastException
- 如果指定的元素类型与此双端队列不兼容(可选)
NullPointerException
- 如果指定元素为 null,并且此双端队列不允许 null 元素(可选)
int size()
Collection<E>
中的
size
Iterator<E> iterator()
Iterator<E> descendingIterator()