Module  java.base
软件包  java.util.concurrent

Class ConcurrentLinkedDeque<E>

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

    public class ConcurrentLinkedDeque<E>
extends AbstractCollection<E>
implements Deque<E>, Serializable
    基于链接节点的无界并发deque 。 并发插入，删除和访问操作可以跨多个线程安全执行。 A ConcurrentLinkedDeque是许多线程将共享对公共集合的访问的适当选择。 像大多数其他并发集合实现一样，此类不允许使用null元素。

    迭代器和拼接器是weakly consistent 。

    请注意，与大多数集合不同， size方法不是一个恒定时间的操作。 由于这些deques的异步性质，确定当前元素数量需要遍历元素，因此如果在遍历期间修改此集合，则可能会报告不准确的结果。

    该添加，删除，或检查多个元件批量操作，如addAll(java.util.Collection<? extends E>) ， removeIf(java.util.function.Predicate<? super E>)或forEach(java.util.function.Consumer<? super E>)待原子方式执行， 不能保证。 例如，与addAll操作并发的forEach遍历可能仅观察到一些添加的元素。

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

    内存一致性效果：与其他并发集合一样，在将对象放入ConcurrentLinkedDeque happen-before之后的线程中的ConcurrentLinkedDeque在另一个线程中的ConcurrentLinkedDeque中访问或删除该元素之后。

    这个班是Java Collections Framework的会员。

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

    • 方法摘要

      所有方法  接口方法  具体的方法 
      Modifier and Type 方法 描述
      boolean add​(E e)
      在此deque的尾部插入指定的元素。
      boolean addAll​(Collection<? extends E> c)
      按照指定集合的迭代器返回的顺序将指定集合中的所有元素追加到该deque的末尾。
      void addFirst​(E e)
      在此deque前面插入指定的元素。
      void addLast​(E e)
      在此deque的末尾插入指定的元素。
      void clear​()
      从这个deque中删除所有的元素。
      boolean contains​(Object o)
      如果此deque包含指定的元素，则返回 true 。
      Iterator<E> descendingIterator​()
      以相反的顺序返回此deque中的元素的迭代器。
      E element​()
      检索但不删除由此deque表示的队列的头部（换句话说，该deque的第一个元素）。
      void forEach​(Consumer<? super E> action)
      对 Iterable每个元素执行给定的操作，直到所有元素都被处理或动作引发异常。
      E getFirst​()
      检索，但不删除，这个deque的第一个元素。
      E getLast​()
      检索，但不删除，这个deque的最后一个元素。
      boolean isEmpty​()
      如果此集合不包含元素，则返回 true 。
      Iterator<E> iterator​()
      以正确的顺序返回此deque中的元素的迭代器。
      boolean offer​(E e)
      在此deque的尾部插入指定的元素。
      boolean offerFirst​(E e)
      在此deque前面插入指定的元素。
      boolean offerLast​(E e)
      在此deque的末尾插入指定的元素。
      E peek​()
      检索但不删除由此deque表示的队列的头部（换句话说，该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表示的堆栈（换句话说，在此deque的头部），如果可以立即执行此操作而不违反容量限制，则抛出 IllegalStateException如果当前没有可用空间）。
      E remove​()
      检索并删除由此deque表示的队列的头部（换句话说，该deque的第一个元素）。
      boolean remove​(Object o)
      从此deque中删除指定元素的第一个出现。
      boolean removeAll​(Collection<?> c)
      删除指定集合中包含的所有此集合的元素（可选操作）。
      E removeFirst​()
      检索并删除此deque的第一个元素。
      boolean removeFirstOccurrence​(Object o)
      从此deque中删除指定元素的第一个出现。
      boolean removeIf​(Predicate<? super E> filter)
      删除满足给定谓词的此集合的所有元素。
      E removeLast​()
      检索并删除此deque的最后一个元素。
      boolean removeLastOccurrence​(Object o)
      从此deque中删除指定元素的最后一次出现。
      boolean retainAll​(Collection<?> c)
      仅保留此集合中包含在指定集合中的元素（可选操作）。
      int size​()
      返回此deque中的元素数。
      Spliterator<E> spliterator​()
      在此deque中的元素上返回Spliterator 。
      Object[] toArray​()
      以适当的顺序（从第一个到最后一个元素）返回一个包含此deque中所有元素的数组。
      <T> T[] toArray​(T[] a)
      以适当的顺序（从第一个到最后一个元素）返回一个包含此deque中所有元素的数组; 返回的数组的运行时类型是指定数组的运行时类型。
      String toString​()
      返回此集合的字符串表示形式。

    • 构造方法详细信息

      • ConcurrentLinkedDeque

        public ConcurrentLinkedDeque​()
        构造一个空的德克。

      • ConcurrentLinkedDeque

        public ConcurrentLinkedDeque​(Collection<? extends E> c)
        构造最初包含给定集合的元素的deque，以集合的迭代器的遍历顺序添加。
        参数
        c - 最初包含的元素的集合
        异常
        NullPointerException - 如果指定的集合或其任何元素为空

    • 方法详细信息

      • offerFirst

        public boolean offerFirst​(E e)
        在此deque前面插入指定的元素。 由于deque是无限制的，这种方法永远不会返回false 。
        Specified by:
        offerFirst在接口 Deque<E>
        参数
        e - 要添加的元素
        结果
        true （由 Deque.offerFirst(E)指定）
        异常
        NullPointerException - 如果指定的元素为空

      • offerLast

        public boolean offerLast​(E e)
        在此deque的末尾插入指定的元素。 由于deque是无限制的，这种方法永远不会返回false 。

        此方法相当于add(E) 。

        Specified by:
        offerLast在接口 Deque<E>
        参数
        e - 要添加的元素
        结果
        true （由 Deque.offerLast(E)指定）
        异常
        NullPointerException - 如果指定的元素为空

      • 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是空的

      • 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是空的

      • 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是空的

      • 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是空的

      • offer

        public boolean offer​(E e)
        在此deque的尾部插入指定的元素。 由于false是无限的，这种方法永远不会返回false 。
        Specified by:
        offer在接口 Deque<E>
        Specified by:
        offer在接口 Queue<E>
        参数
        e - 要添加的元素
        结果
        true （由 Queue.offer(E)指定）
        异常
        NullPointerException - 如果指定的元素为空

      • poll

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

        此方法相当于Deque.pollFirst() 。

        Specified by:
        poll在接口 Deque<E>
        Specified by:
        poll在接口 Queue<E>
        结果
        这个deque的第一个元素，或 null如果这个deque是空的

      • peek

        public E peek​()
        说明从接口Deque复制
        检索但不删除由此deque表示的队列的头部（换句话说，该deque的第一个元素），如果此deque为空，则返回null 。

        此方法相当于Deque.peekFirst() 。

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

      • remove

        public E remove​()
        说明从界面Deque复制
        检索并删除由此deque表示的队列的头部（换句话说，该deque的第一个元素）。 此方法与poll()不同之处在于，如果此deque为空，它将抛出异常。

        此方法相当于Deque.removeFirst() 。

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

      • pop

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

        此方法相当于Deque.removeFirst() 。

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

      • element

        public E element​()
        说明从接口Deque复制
        检索但不删除由此deque表示的队列的头部（换句话说，该deque的第一个元素）。 此方法与peek的不同之处在于，如果此deque为空，它将抛出异常。

        此方法相当于Deque.getFirst() 。

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

      • push

        public void push​(E e)
        说明从界面Deque复制
        将元素推送到由此deque表示的堆栈（换句话说，在该deque的头部），如果可以立即执行此操作而不违反容量限制，则抛出IllegalStateException如果当前没有可用空间）。

        此方法相当于Deque.addFirst(E) 。

        Specified by:
        push在接口 Deque<E>
        参数
        e - 要推的元素
        异常
        NullPointerException - 如果指定的元素为空，并且此deque不允许空元素

      • removeFirstOccurrence

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

      • removeLastOccurrence

        public boolean removeLastOccurrence​(Object o)
        从此deque中删除指定元素的最后一次出现。 如果deque不包含元素，则它不变。 更正式地，删除最后一个元素e ，使得o.equals(e) （如果这样的元素存在）。 如果此deque包含指定的元素（或等效地，如果此deque因呼叫而改变），则返回true 。
        Specified by:
        removeLastOccurrence在接口 Deque<E>
        参数
        o - 要从此deque中删除的元素（如果存在）
        结果
        如果deque包含指定的元素， 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

      • isEmpty

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

      • size

        public int size​()
        返回此deque中的元素数。 如果此deque包含超过Integer.MAX_VALUE元素，则返回Integer.MAX_VALUE 。

        请注意，与大多数集合不同，此方法不是一个常时操作。 由于这些deques的异步性质，确定当前数量的元素需要遍历它们才能对它们进行计数。 此外，在执行此方法期间，大小可能会发生更改，在这种情况下，返回的结果将不准确。 因此，这种方法在并发应用程序中通常不是很有用。

        Specified by:
        size在接口 Collection<E>
        Specified by:
        size在接口 Deque<E>
        Specified by:
        size在 AbstractCollection<E>
        结果
        这个deque中的元素数量

      • 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包含指定的元素
        异常
        NullPointerException - 如果指定的元素为空

      • toString

        public String toString​()
        描述从类别复制： AbstractCollection
        返回此集合的字符串表示形式。 字符串表示由集合的元素的列表按照它们的迭代器返回的顺序包含在方括号（ "[]" ）中。 相邻元素由字符", " （逗号和空格）分隔。 元素将转换为字符串，如String.valueOf(Object) 。
        重写：
        toString在 AbstractCollection<E>
        结果
        此集合的字符串表示形式

      • 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 - 如果指定的数组为空

      • descendingIterator

        public Iterator<E> descendingIterator​()
        以相反的顺序返回此deque中的元素的迭代器。 元素将从最后（尾）到第一（头）的顺序返回。

        返回的迭代器是weakly consistent 。

        Specified by:
        descendingIterator在接口 Deque<E>
        结果
        在这个deque中的元素的迭代器以相反的顺序

      • removeIf

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

      • forEach

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

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

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