Module  java.base
软件包  java.util

Class ArrayDeque<E>

  • 参数类型
    E - 在这个deque持有的元素的类型
    All Implemented Interfaces:
    Serializable ， Cloneable ， Iterable<E> ， Collection<E> ， Deque<E> ， Queue<E> 

    public class ArrayDeque<E>
extends AbstractCollection<E>
implements Deque<E>, Cloneable, Serializable
    Deque接口的可调整大小的数组实现。 数组deques没有容量限制; 他们根据需要增长以支持使用。 它们不是线程安全的; 在没有外部同步的情况下，它们不支持多线程的并发访问。 零元素被禁止。 当用作堆栈时， 此类可能比Stack更快，并且当用作队列时快于LinkedList 。

    大多数ArrayDeque操作以摊销的恒定时间运行。 例外包括remove ， removeFirstOccurrence ， removeLastOccurrence ， contains ， iterator.remove() ，和批量操作，所有这些都在运行线性时间。

    此类的iterator方法返回的迭代器是故障快速的 ：如果在迭代器创建之后的任何时候修改了deque，除了通过迭代器自己的remove方法之外，迭代器通常会抛出一个ConcurrentModificationException 。 因此，面对并发修改，迭代器将快速而干净地失败，而不是在未来未确定的时间冒着任意的非确定性行为。

    请注意，迭代器的故障快速行为无法保证，因为一般来说，在不同步并发修改的情况下，无法做出任何硬性保证。 失败快速迭代器ConcurrentModificationException抛出ConcurrentModificationException 。 因此，编写依赖于此异常的程序的正确性将是错误的： 迭代器的故障快速行为应仅用于检测错误。

    该类及其迭代器实现Collection和Iterator接口的所有可选方法。

    这个班是Java Collections Framework的会员。

    从以下版本开始：
    1.6
    另请参见：
    Serialized Form

    • 构造方法摘要

      构造方法  
      Constructor 描述
      ArrayDeque​()
      构造一个空数组deque，初始容量足以容纳16个元素。
      ArrayDeque​(int numElements)
      构造一个空数组deque，初始容量足以容纳指定数量的元素。
      ArrayDeque​(Collection<? extends E> c)
      构造一个包含指定集合的元素的deque，按照它们由集合的迭代器返回的顺序。

    • 方法摘要

      所有方法  接口方法  具体的方法 
      Modifier and Type 方法 描述
      boolean add​(E e)
      在此deque的末尾插入指定的元素。
      boolean addAll​(Collection<? extends E> c)
      在指定集合的末尾添加指定集合中的所有元素，如同通过按集合的迭代器返回的顺序调用每个 元素addLast(E) 。
      void addFirst​(E e)
      在此deque前面插入指定的元素。
      void addLast​(E e)
      在此deque的末尾插入指定的元素。
      void clear​()
      从这个deque中删除所有的元素。
      ArrayDeque<E> clone​()
      返回此deque的副本。
      boolean contains​(Object o)
      如果此deque包含指定的元素，则返回 true 。
      Iterator<E> descendingIterator​()
      以相反的顺序返回此deque中的元素的迭代器。
      E element​()
      检索，但不删除，由这个deque表示的队列的头。
      void forEach​(Consumer<? super E> action)
      对 Iterable每个元素执行给定的操作，直到所有元素都被处理或者动作引发异常。
      E getFirst​()
      检索，但不删除，这个deque的第一个元素。
      E getLast​()
      检索，但不删除，这个deque的最后一个元素。
      boolean isEmpty​()
      如果此deque不包含元素，则返回 true 。
      Iterator<E> iterator​()
      返回此deque中的元素的迭代器。
      boolean offer​(E e)
      在此deque的末尾插入指定的元素。
      boolean offerFirst​(E e)
      在此deque前面插入指定的元素。
      boolean offerLast​(E e)
      在此deque的末尾插入指定的元素。
      E peek​()
      检索但不删除由此deque表示的队列的头，或者如果此deque为空，则返回 null 。
      E peekFirst​()
      检索但不删除此deque的第一个元素，如果此deque为空，则返回 null 。
      E peekLast​()
      检索但不删除此deque的最后一个元素，如果此deque为空，则返回 null 。
      E poll​()
      检索并删除由此deque表示的队列的头部（换句话说，该deque的第一个元素），或者如果此deque为空，则返回 null 。
      E pollFirst​()
      检索并删除此deque的第一个元素，如果此deque为空，则返回 null 。
      E pollLast​()
      检索并删除此deque的最后一个元素，如果此deque为空，则返回 null 。
      E pop​()
      从这个deque表示的堆栈中弹出一个元素。
      void push​(E e)
      将元素推送到由此deque表示的堆栈上。
      E remove​()
      检索并删除由此deque表示的队列的头部。
      boolean remove​(Object o)
      从此deque中删除指定元素的单个实例。
      boolean removeAll​(Collection<?> c)
      删除指定集合中包含的所有此集合的元素（可选操作）。
      E removeFirst​()
      检索并删除此deque的第一个元素。
      boolean removeFirstOccurrence​(Object o)
      删除此deque中指定元素的第一个出现（从头到尾遍历deque时）。
      boolean removeIf​(Predicate<? super E> filter)
      删除满足给定谓词的此集合的所有元素。
      E removeLast​()
      检索并删除此deque的最后一个元素。
      boolean removeLastOccurrence​(Object o)
      删除此deque中指定元素的最后一次（从头到尾遍历deque时）。
      boolean retainAll​(Collection<?> c)
      仅保留此集合中包含在指定集合中的元素（可选操作）。
      int size​()
      返回此deque中的元素数。
      Spliterator<E> spliterator​()
      在此deque中的元素上创建一个late-binding和失败快速的 Spliterator 。
      Object[] toArray​()
      以适当的顺序返回一个包含此deque中所有元素的数组（从第一个到最后一个元素）。
      <T> T[] toArray​(T[] a)
      以正确的顺序返回一个包含此deque中所有元素的数组（从第一个到最后一个元素）; 返回的数组的运行时类型是指定数组的运行时类型。

    • 构造方法详细信息

      • ArrayDeque

        public ArrayDeque​()
        构造一个空数组deque，初始容量足以容纳16个元素。

      • ArrayDeque

        public ArrayDeque​(int numElements)
        构造一个空数组deque，初始容量足以容纳指定数量的元素。
        参数
        numElements - deque初始容量的下限

      • ArrayDeque

        public ArrayDeque​(Collection<? extends E> c)
        构造一个包含指定集合的元素的deque，按照它们由集合的迭代器返回的顺序。 （集合的迭代器返回的第一个元素成为第一个元素，或者是deque的前面 ）
        参数
        c - 其元素将被放 c的集合
        异常
        NullPointerException - 如果指定的集合为空

    • 方法详细信息

      • addFirst

        public void addFirst​(E e)
        在此deque前面插入指定的元素。
        Specified by:
        addFirst在接口 Deque<E>
        参数
        e - 要添加的元素
        异常
        NullPointerException - 如果指定的元素为空

      • removeFirst

        public E removeFirst​()
        说明从接口Deque复制
        检索并删除此deque的第一个元素。 此方法与pollFirst不同之处在于，如果此deque为空，它将抛出异常。
        Specified by:
        removeFirst在接口 Deque<E>
        结果
        这个德克的头
        异常
        NoSuchElementException - 如果这个deque是空的

      • removeLast

        public E removeLast​()
        描述从接口Deque复制
        检索并删除此deque的最后一个元素。 该方法与pollLast的区别在于，如果此deque为空，它将抛出异常。
        Specified by:
        removeLast在接口 Deque<E>
        结果
        这个德克的尾巴
        异常
        NoSuchElementException - 如果这个deque是空的

      • pollFirst

        public E pollFirst​()
        描述从接口Deque复制
        检索并删除此deque的第一个元素，如果此deque为空，则返回 null 。
        Specified by:
        pollFirst在接口 Deque<E>
        结果
        这个deque的头，或 null如果这个deque是空的

      • pollLast

        public E pollLast​()
        说明从界面Deque复制
        检索并删除此deque的最后一个元素，如果此deque为空，则返回 null 。
        Specified by:
        pollLast在接口 Deque<E>
        结果
        这个deque的尾巴，或 null如果这个deque是空的

      • getFirst

        public E getFirst​()
        说明从接口Deque复制
        检索，但不删除，这个deque的第一个元素。 此方法与peekFirst不同之处在于，如果此deque为空，它将抛出异常。
        Specified by:
        getFirst在接口 Deque<E>
        结果
        这个德克的头
        异常
        NoSuchElementException - 如果这个deque是空的

      • getLast

        public E getLast​()
        描述从接口Deque复制
        检索，但不删除，这个deque的最后一个元素。 此方法与peekLast不同之处在于，如果此deque为空，它将抛出异常。
        Specified by:
        getLast在接口 Deque<E>
        结果
        这个德克的尾巴
        异常
        NoSuchElementException - 如果这个deque是空的

      • peekFirst

        public E peekFirst​()
        说明从接口Deque复制
        检索但不删除此deque的第一个元素，如果此deque为空，则返回 null 。
        Specified by:
        peekFirst在接口 Deque<E>
        结果
        这个deque的头，或 null如果这个deque是空的

      • peekLast

        public E peekLast​()
        描述从接口Deque复制
        检索但不删除此deque的最后一个元素，如果此deque为空，则返回 null 。
        Specified by:
        peekLast在接口 Deque<E>
        结果
        这个deque的尾巴，或 null如果这个deque是空的

      • removeFirstOccurrence

        public boolean removeFirstOccurrence​(Object o)
        删除此deque中指定元素的第一个出现（从头到尾遍历deque时）。 如果deque不包含元素，则它不变。 更正式地，删除第一元素e ，使得o.equals(e) （如果这样的元素存在）。 如果此deque包含指定的元素（或等效地，如果此deque由于调用而更改），则返回true 。
        Specified by:
        removeFirstOccurrence在接口 Deque<E>
        参数
        o - 要从此deque中删除的元素（如果存在）
        结果
        true如果deque包含指定的元素

      • removeLastOccurrence

        public boolean removeLastOccurrence​(Object o)
        删除此deque中指定元素的最后一次（从头到尾遍历deque时）。 如果deque不包含元素，则它不变。 更正式地，删除最后一个元素e ，使得o.equals(e) （如果这样的元素存在）。 如果此deque包含指定的元素（或等效地，如果该deque由于调用而更改），则返回true 。
        Specified by:
        removeLastOccurrence在接口 Deque<E>
        参数
        o - 要从此deque移除的元素（如果存在）
        结果
        如果deque包含指定的元素， true

      • remove

        public E remove​()
        检索并删除由此deque表示的队列的头部。 此方法与poll的区别在于，如果此deque为空，它将抛出异常。

        这个方法相当于removeFirst() 。

        Specified by:
        remove在接口 Deque<E>
        Specified by:
        remove在接口 Queue<E>
        结果
        由这个德克队代表的队列的头
        异常
        NoSuchElementException - 如果这个deque是空的

      • poll

        public E poll​()
        检索并删除由此deque表示的队列的头部（换句话说，该deque的第一个元素），如果此deque为空，则返回null 。

        此方法相当于pollFirst() 。

        Specified by:
        poll在接口 Deque<E>
        Specified by:
        poll在接口 Queue<E>
        结果
        由这个deque代表的队列的头，或者如果这个deque是空的，则是 null

      • element

        public E element​()
        检索，但不删除，由这个deque表示的队列的头。 此方法与peek不同之处在于，如果此deque为空，它将抛出异常。

        这个方法相当于getFirst() 。

        Specified by:
        element在接口 Deque<E>
        Specified by:
        element在接口 Queue<E>
        结果
        由这个德克队代表的队列的头
        异常
        NoSuchElementException - 如果这个deque是空的

      • peek

        public E peek​()
        检索但不删除由此deque表示的队列的头部，如果此deque为空，则返回null 。

        此方法相当于peekFirst() 。

        Specified by:
        peek在接口 Deque<E>
        Specified by:
        peek在接口 Queue<E>
        结果
        由这个deque表示的队列的头，或者如果这个deque是空的，则是 null

      • push

        public void push​(E e)
        将元素推送到由此deque表示的堆栈上。 换句话说，将该元素插入到此deque的前面。

        此方法相当于addFirst(E) 。

        Specified by:
        push在接口 Deque<E>
        参数
        e - 要推的元素
        异常
        NullPointerException - 如果指定的元素为空

      • pop

        public E pop​()
        从这个deque表示的堆栈中弹出一个元素。 换句话说，删除并返回此deque的第一个元素。

        此方法相当于removeFirst() 。

        Specified by:
        pop在接口 Deque<E>
        结果
        这个deque前面的元素（它是由这个deque表示的堆栈的顶部）
        异常
        NoSuchElementException - 如果这个deque是空的

      • isEmpty

        public boolean isEmpty​()
        如果此deque不包含元素，则返回 true 。
        Specified by:
        isEmpty在接口 Collection<E>
        重写：
        isEmpty在 AbstractCollection<E>
        结果
        true如果这个deque不包含元素

      • descendingIterator

        public Iterator<E> descendingIterator​()
        描述从接口Deque复制
        以相反的顺序返回此deque中的元素的迭代器。 元素将从最后（尾）到第一（头）的顺序返回。
        Specified by:
        descendingIterator在接口 Deque<E>
        结果
        在这个deque中的元素的反向迭代器

      • forEach

        public void forEach​(Consumer<? super E> action)
        描述从接口Iterable复制
        对Iterable每个元素执行给定的操作，直到所有元素都被处理或动作引发异常。 如果指定了该顺序，则按迭代的顺序执行操作。 动作抛出的异常被转发给呼叫者。

        如果操作执行修改元素的基础源的副作用，则该方法的行为是未指定的，除非重写类已指定并发修改策略。

        Specified by:
        forEach在接口 Iterable<E>
        参数
        action - 要为每个元素执行的操作
        异常
        NullPointerException - 如果指定的动作为空

      • removeIf

        public boolean removeIf​(Predicate<? super E> filter)
        说明从接口Collection复制
        删除满足给定谓词的此集合的所有元素。 在迭代或谓词中抛出的错误或运行时异常被转发给调用者。
        Specified by:
        removeIf在接口 Collection<E>
        参数
        filter - 要删除的元素返回 true的谓词
        结果
        true如果有任何元素被删除
        异常
        NullPointerException - 如果指定的过滤器为空

      • contains

        public boolean contains​(Object o)
        如果此deque包含指定的元素，则返回true 。 更正式地说，返回true当且仅当此双端队列至少包含一个元素e这样o.equals(e) 。
        Specified by:
        contains在接口 Collection<E>
        Specified by:
        contains在接口 Deque<E>
        重写：
        contains在 AbstractCollection<E>
        参数
        o - 要检查在这个deque的遏制的对象
        结果
        如果此deque包含指定的元素， true

      • remove

        public boolean remove​(Object o)
        从此deque中删除指定元素的单个实例。 如果deque不包含元素，则它不变。 更正式地，删除第一个元素e ，使得o.equals(e) （如果这样的元素存在）。 如果此deque包含指定的元素（或等效地，如果该deque由于调用而更改），则返回true 。

        此方法相当于removeFirstOccurrence(Object) 。

        Specified by:
        remove在接口 Collection<E>
        Specified by:
        remove在接口 Deque<E>
        重写：
        remove在 AbstractCollection<E>
        参数
        o - 要从此deque中删除的元素（如果存在）
        结果
        true如果这个deque包含指定的元素

      • toArray

        public Object[] toArray​()
        以适当的顺序返回一个包含此deque中所有元素的数组（从第一个到最后一个元素）。

        返回的数组将是“安全的”，因为这个deque不会保留对它的引用。 （换句话说，这个方法必须分配一个新的数组）。 因此，调用者可以自由地修改返回的数组。

        此方法充当基于阵列和基于集合的API之间的桥梁。

        Specified by:
        toArray在接口 Collection<E>
        重写：
        toArray在 AbstractCollection<E>
        结果
        一个包含此deque中所有元素的数组

      • toArray

        public <T> T[] toArray​(T[] a)
        以正确的顺序返回一个包含此deque中所有元素的数组（从第一个到最后一个元素）; 返回的数组的运行时类型是指定数组的运行时类型。 如果deque适合指定的数组，则返回其中。 否则，将为指定数组的运行时类型和此deque的大小分配一个新数组。

        如果这个deque适合指定的数组，有空余的空间（即数组的元素比此deque更多），紧接着deque结尾之后的数组中的元素设置为null 。

        像toArray()方法一样，此方法充当基于阵列和基于集合的API之间的桥梁。 此外，该方法允许精确地控制输出阵列的运行时类型，并且在某些情况下可以用于节省分配成本。

        假设x是一个已知只包含字符串的deque。 以下代码可用于将deque转储到新分配的String数组中： 

          String[] y = x.toArray(new String[0]);
        请注意， toArray(new Object[0])功能与toArray()相同。
        Specified by:
        toArray在接口 Collection<E>
        重写：
        toArray在 AbstractCollection<E>
        参数类型
        T - 包含集合的数组的运行时类型
        参数
        a - 要存储deque的元素的阵列，如果它足够大; 否则，为此目的分配相同运行时类型的新数组
        结果
        一个包含此deque中所有元素的数组
        异常
        ArrayStoreException - 如果指定数组的运行时类型不是此deque中每个元素的运行时类型的超类型
        NullPointerException - 如果指定的数组为空