源码学习:Java 本地队列 - java.util.Deque

1、接口定义

支持在头尾两端插入和移除元素的线性集合(双端队列:Double Ended Queue,Deque,读音:英[dek]|美[dɛk] )。大多数 Deque 实现对于它们可能包含的元素数量没有固定的限制,不过这个接口对容量设限以及没有固定容量限制的那些 Deque 实现都支持。

该接口定义了访问 Deque 两端元素的方法,方法被提供用于插入提取检索操作。这些操作方法都以两种形式存在:一种在操作失败时抛出异常,另一种是返回一个特殊值(根据操作的不同,可以是 nullfalse)。后一种形式的插入操作是专门为使用容量设限的 Deque 实现而设计的;在大多数实现中,插入操作不会失败。

- 抛出异常 返回特殊值
插入 addFirst(e)
addLast(e)
offerFirst(e)
offerLast(e)
提取/移除 removeFirst()
removeLast()
pollFirst()
pollLast()
检索/检查 getFirst()
getLast()
peekFirst()
peekLast()

这个接口继承了 Queue 接口。当使用 Deque 作为 Queue 队列时,会产生 FIFO (先进先出)行为:元素被添加到 Deque 的尾部,然后从头部移除。从 Queue 接口继承的方法精确地等同于 Deque 方法,如下表所示:

Queue 方法 等效 Deque 方法
add(e) addLast(e)
offer(e) offerLast(e)
remove() removeFirst()
poll() pollFirst()
element() getFirst()
peek() peekFirst()

Deque 也可用作 LIFO(后进先出) Stack 堆栈。应该优先使用这个接口,而不是历史遗留的 java.util.Stack。当一个 Deque 被用作堆栈时,元素从该 Deque 的头部被压入和弹出。Stack 方法与 Deque 方法完全等价,如下表所示:

Stack 方法 等效 Deque 方法
push(e) addFirst(e)
pop() removeFirst()
peek() peekFirst()

请注意,当 Deque 被用作 Queue 队列或 Stack 堆栈时,peek() 方法同样有效;在这两种情况下,元素都是从 Deque 的头部提取的。

这个接口还提供了两个方法来移除内部元素,removeFirstOccurrence()removeLastOccurrence()

java.util.List 接口不同,该接口不支持对元素的索引访问。

虽然 Deque 实现并不严格要求禁止插入 null 元素,但强烈建议这样做。任何允许 null 元素的 Deque 实现的使用者都强烈建议不要利用插入 null 元素的能力。这是因为 null 会被各种方法用作特殊的返回值,以表明 Deque 为空。

Deque 实现通常不定义 equals()hashCode() 的基于元素版本的方法,而是从类 Object 继承基于标识版本的方法。

java.util.Deque 继承于 java.util.Queue 接口,接口继承关系如下图所示:

deque

2、方法声明

1)void addFirst(E e);

  • 在不违反容量限制的情况下立即将指定的元素插入到该 Deque 的头部中,当使用容量设限的 Deque 时,通常最好使用 offerFirst() 方法;

  • 如果此时由于容量限制(没有可用空间)而不能添加元素,则抛出 java.lang.IllegalStateException

  • 如果指定元素的类阻止将其添加到此队列中,则抛出 java.lang.ClassCastException

  • 如果指定的元素为 null 且该队列不允许 null 元素,则抛出 java.lang.NullPointerException

  • 如果此元素的某些属性阻止将其添加到此队列中,则抛出 java.lang.IllegalArgumentException

2)void addLast(E e);

  • 在不违反容量限制的情况下立即将指定的元素插入到该 Deque 的尾部中,当使用容量设限的 Deque 时,通常最好使用 offerLast() 方法;

  • 如果此时由于容量限制(没有可用空间)而不能添加元素,则抛出 java.lang.IllegalStateException

  • 如果指定元素的类阻止将其添加到此队列中,则抛出 java.lang.ClassCastException

  • 如果指定的元素为 null 且该队列不允许 null 元素,则抛出 java.lang.NullPointerException

  • 如果此元素的某些属性阻止将其添加到此队列中,则抛出 java.lang.IllegalArgumentException

3)boolean offerFirst(E e);

  • 将指定的元素插入到 Deque 的头部,除非它违反容量限制,成功时返回 true,否则返回 false。当使用容量设限的队列时,这个方法通常比 addFirst() 更适合使用,因为在不能添加元素时,addFirst() 方法只能抛出异常;

  • 如果指定元素的类阻止将其添加到此队列中,则抛出 java.lang.ClassCastException

  • 如果指定的元素为 null 且该队列不允许 null 元素,则抛出 java.lang.NullPointerException

  • 如果此元素的某些属性阻止将其添加到此队列中,则抛出 java.lang.IllegalArgumentException

4)boolean offerLast(E e);

  • 将指定的元素插入到 Deque 的尾部,除非它违反容量限制,成功时返回 true,否则返回 false。当使用容量设限的队列时,这个方法通常比 addLast() 更适合使用,因为在不能添加元素时,addLast() 方法只能抛出异常;

  • 如果指定元素的类阻止将其添加到此队列中,则抛出 java.lang.ClassCastException

  • 如果指定的元素为 null 且该队列不允许 null 元素,则抛出 java.lang.NullPointerException

  • 如果此元素的某些属性阻止将其添加到此队列中,则抛出 java.lang.IllegalArgumentException

5)E removeFirst();

  • 检索并移除该 Deque 的第一个元素(头部元素)。此方法与 pollFirst() 的不同之处在于:当该 Deque 为空时,则抛出异常;

  • 如果该 Deque 为空,则抛出 java.util.NoSuchElementException

6)E removeLast();

  • 检索并移除该 Deque 的最后一个元素(尾部元素)。此方法与 pollLast() 的不同之处在于:当该 Deque 为空时,则抛出异常;

  • 如果该 Deque 为空,则抛出 java.util.NoSuchElementException

7)E pollFirst();

  • 检索并移除该 Deque 的第一个元素(头部元素),如果该 Deque 为空,则返回 null

8)E pollLast();

  • 检索并移除该 Deque 的最后一个元素(尾部元素),如果该 Deque 为空,则返回 null

9)E getFirst();

  • 检索(但并不移除)该 Deque 的第一个元素(头部元素)。此方法与 peekFirst() 的不同之处在于:当该 Deque 为空时,则抛出异常;

  • 如果该 Deque 为空,则抛出 java.util.NoSuchElementException

10)E getLast();

  • 检索(但并不移除)该 Deque 的最后一个元素(尾部元素)。此方法与 peekLast() 的不同之处在于:当该 Deque 为空时,则抛出异常;

  • 如果该 Deque 为空,则抛出 java.util.NoSuchElementException

11)E peekFirst();

  • 检索(但并不移除)该 Deque 的第一个元素(头部元素),如果该 Deque 为空,则返回 null

12)E peekLast();

  • 检索(但并不移除)该 Deque 的最后一个元素(尾部元素),如果该 Deque 为空,则返回 null

13)boolean removeFirstOccurrence(Object o);

  • Deque 中移除指定元素的第一个匹配项。如果该 Deque 中不包含该元素,则它不会有所改变。更正式地说,即移除第一个满足 (o==null ? e==null : o.equals(e)) 表达式的元素 e(如果存在这样的元素的话)。如果该 Deque 包含指定的元素则移除它并返回 true

  • 如果指定元素的类型与 Deque 不兼容,则抛出 java.lang.ClassCastException(可选);

  • 如果指定的元素是 null,而这个 Deque 是不允许 null 元素的,则抛出 java.lang.NullPointerException(可选)。

注:“可选”指具体的 Deque 实现可根据自己的实现目的而选择合适的策略,或返回此异常,或返回成功。

14)boolean removeLastOccurrence(Object o);

  • Deque 中移除指定元素的最后一个匹配项。如果该 Deque 中不包含该元素,则它不会有所改变。更正式地说,即移除最后一个满足 (o==null ? e==null : o.equals(e)) 表达式的元素 e(如果存在这样的元素的话)。如果该 Deque 包含指定的元素则移除它并返回 true

  • 如果指定元素的类型与 Deque 不兼容,则抛出 java.lang.ClassCastException(可选);

  • 如果指定的元素是 null,而这个 Deque 是不允许 null 元素的,则抛出 java.lang.NullPointerException(可选)。

— 以下为 Queue 队列方法 —

15)boolean add(E e);

  • 如果可以在不违反容量限制的情况下立即将指定的元素插入到该 Deque 所表示的 Queue 队列中(换句话说,插入到该 Deque 的尾部),则在插入成功时返回 true(如 Collection.add() 所指定的),当使用容量设限的 Deque 时,通常最好使用 offer() 方法。此方法与 addLast() 方法等效

  • 如果此时由于容量限制(没有可用空间)而不能添加元素,则抛出 java.lang.IllegalStateException

  • 如果指定元素的类阻止将其添加到此队列中,则抛出 java.lang.ClassCastException

  • 如果指定的元素为 null 且该队列不允许 null 元素,则抛出 java.lang.NullPointerException

  • 如果此元素的某些属性阻止将其添加到此队列中,则抛出 java.lang.IllegalArgumentException

16)boolean offer(E e);

  • 如果可以在不违反容量限制的情况下立即将指定的元素插入到该 Deque 所表示的 Queue 队列中(换句话说,插入到该 Deque 的尾部),则在插入成功时返回 true,否则返回 false,当使用容量设限的 Deque 时,这个方法通常比 add() 更适合使用,因为在因容量限制(没有可用空间)而不能添加元素时,add() 方法只能抛出异常。此方法与 offerLast() 方法等效

  • 如果指定元素的类阻止将其添加到此队列中,则抛出 java.lang.ClassCastException

  • 如果指定的元素为 null 且该队列不允许 null 元素,则抛出 java.lang.NullPointerException

  • 如果此元素的某些属性阻止将其添加到此队列中,则抛出 java.lang.IllegalArgumentException

17)E remove();

  • 检索并移除此 Deque 所表示的 Queue 队列的头部元素(换句话说,移除该 Deque 的第一个元素),此方法与 poll() 方法的不同之处在于:如果队列为空,则抛出异常。此方法与 removeFirst() 方法等效

  • 如果队列为空,则抛出 java.util.NoSuchElementException

18)E poll();

  • 检索并移除此 Deque 所表示的 Queue 队列的头部元素(换句话说,移除该 Deque 的第一个元素),如果队列为空,返回 null此方法与 pollFirst() 方法等效

19)E element();

  • 检索(但并不移除)此 Deque 所表示的 Queue 队列的头部元素(换句话说,检索该 Deque 的第一个元素),此方法与 peek() 方法的不同之处在于:如果队列为空,则抛出异常。此方法与 getFirst() 方法等效

  • 如果队列为空,则抛出 java.util.NoSuchElementException

20)E peek();

  • 检索(但并不移除)此 Deque 所表示的 Queue 队列的头部元素(换句话说,检索该 Deque 的第一个元素),如果队列为空,返回 null此方法与 peekFirst() 方法等效

— 以下为 Stack 堆栈方法 —

21)void push(E e);

  • 在不违反容量限制的情况下立即将一个元素压入到该 Deque 所表示的 Stack 堆栈中(换句话说,压入到该 Deque 的头部)。此方法与 addFirst() 方法等效

  • 如果此时由于容量限制(没有可用空间)而不能添加元素,则抛出 java.lang.IllegalStateException

  • 如果指定元素的类阻止将其添加到此堆栈中,则抛出 java.lang.ClassCastException

  • 如果指定的元素为 null 且该堆栈不允许 null 元素,则抛出 java.lang.NullPointerException

  • 如果此元素的某些属性阻止将其添加到此堆栈中,则抛出 java.lang.IllegalArgumentException

22)E pop();

  • 从这个 Deque 所表示的 Stack 堆栈中弹出一个元素。换句话说,移除并返回该 Deque 的第一个元素。此方法与 removeFirst() 方法等效

  • 如果堆栈为空,则抛出 java.util.NoSuchElementException

— 以下为 Collection 集合方法 —

23)boolean remove(Object o);

  • Deque 中移除指定元素的第一个匹配项。如果该 Deque 中不包含该元素,则它不会有所改变。更正式地说,即移除第一个满足 (o==null ? e==null : o.equals(e)) 表达式的元素 e(如果存在这样的元素的话)。如果该 Deque 包含指定的元素则移除它并返回 true此方法与 removeFirstOccurrence(Object o) 方法等效

  • 如果指定元素的类型与 Deque 不兼容,则抛出 java.lang.ClassCastException(可选);

  • 如果指定的元素是 null,而这个 Deque 是不允许 null 元素的,则抛出 java.lang.NullPointerException(可选)。

24)boolean contains(Object o);

  • 如果 Deque 包含指定的元素时返回 true。更正式地说,当且仅当这个 Deque 至少包含一个满足 (o==null ? e==null : o.equals(e)) 表达式的元素 e 时返回 true

  • 如果指定元素的类型与 Deque 不兼容,则抛出 java.lang.ClassCastException(可选);

  • 如果指定的元素是 null,而这个 Deque 是不允许 null 元素的,则抛出 java.lang.NullPointerException(可选)。

25)public int size();

  • 返回 Deque 中包含的元素的数量。

26)Iterator<E> iterator();

  • 按照顺序返回 Deque 中所有元素的迭代器,元素将按从头到尾的顺序返回。

27)Iterator<E> descendingIterator();

  • 以反向顺序返回该 Deque 中所有元素的迭代器,元素将按从尾到头的顺序返回。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,744评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,505评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,105评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,242评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,269评论 6 389
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,215评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,096评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,939评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,354评论 1 311
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,573评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,745评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,448评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,048评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,683评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,838评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,776评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,652评论 2 354

推荐阅读更多精彩内容