模块  java.base
软件包  java.util.concurrent

Class ConcurrentLinkedDeque<E>

  • 参数类型
    E - 此双端队列中保留的元素类型
    实现的所有接口
    Serializable ， Iterable<E> ， Collection<E> ， Deque<E> ， Queue<E> 
    public class ConcurrentLinkedDeque<E>extends AbstractCollection<E>implements Deque<E>, Serializable
    基于链接节点的无界并发deque 。 并发插入，删除和访问操作可跨多个线程安全执行。 当许多线程共享对公共集合的访问权限时， 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在另一个线程。

    此类是Java Collections Framework的成员。

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

    • 方法摘要

      所有方法  实例方法 具体的方法 
      变量和类型 方法 描述
      boolean add​(E e)
      在此双端队列的尾部插入指定的元素。
      boolean addAll​(Collection<? extends E> c)
      将指定集合中的所有元素追加到此双端队列的末尾，按指定集合的迭代器返回它们的顺序。
      void addFirst​(E e)
      在此双端队列的前面插入指定的元素。
      void addLast​(E e)
      在此双端队列的末尾插入指定的元素。
      void clear()
      从此双端队列中删除所有元素。
      boolean contains​(Object o)
      如果此双端队列包含指定的元素，则返回 true 。
      Iterator<E> descendingIterator()
      以相反的顺序返回此双端队列中元素的迭代器。
      E element()
      检索但不删除此双端队列表示的队列的头部（换句话说，此双端队列的第一个元素）。
      void forEach​(Consumer<? super E> action)
      对 Iterable每个元素执行给定操作，直到处理 Iterable所有元素或操作引发异常。
      E getFirst()
      检索但不删除此双端队列的第一个元素。
      E getLast()
      检索但不删除此双端队列的最后一个元素。
      boolean isEmpty()
      如果此集合不包含任何元素，则返回 true 。
      Iterator<E> iterator()
      以适当的顺序返回此双端队列中元素的迭代器。
      boolean offer​(E e)
      在此双端队列的尾部插入指定的元素。
      boolean offerFirst​(E e)
      在此双端队列的前面插入指定的元素。
      boolean offerLast​(E e)
      在此双端队列的末尾插入指定的元素。
      E pop()
      从此双端队列表示的堆栈中弹出一个元素。
      void push​(E e)
      如果可以在不违反容量限制的情况下立即执行此操作， IllegalStateException到此双端队列表示的堆栈（换句话说，在此双端队列的头部），如果当前没有可用空间则抛出 IllegalStateException 。
      E remove()
      检索并删除此双端队列表示的队列的头部（换句话说，此双端队列的第一个元素）。
      boolean remove​(Object o)
      从此双端队列中删除第一次出现的指定元素。
      boolean removeAll​(Collection<?> c)
      删除此集合的所有元素，这些元素也包含在指定的集合中（可选操作）。
      E removeFirst()
      检索并删除此双端队列的第一个元素。
      boolean removeFirstOccurrence​(Object o)
      从此双端队列中删除第一次出现的指定元素。
      boolean removeIf​(Predicate<? super E> filter)
      删除此集合中满足给定谓词的所有元素。
      E removeLast()
      检索并删除此双端队列的最后一个元素。
      boolean removeLastOccurrence​(Object o)
      从此双端队列中删除最后一次出现的指定元素。
      boolean retainAll​(Collection<?> c)
      仅保留此集合中包含在指定集合中的元素（可选操作）。
      int size()
      返回此双端队列中的元素数。
      Spliterator<E> spliterator()
      返回此双端队列中元素的Spliterator 。
      Object[] toArray()
      以适当的顺序（从第一个元素到最后一个元素）返回包含此双端队列中所有元素的数组。
      <T> T[] toArray​(T[] a)
      以适当的顺序（从第一个元素到最后一个元素）返回一个包含此双端队列中所有元素的数组; 返回数组的运行时类型是指定数组的运行时类型。

    • 构造方法详细信息

      • ConcurrentLinkedDeque

        public ConcurrentLinkedDeque()
        构造一个空的双端队列。

      • ConcurrentLinkedDeque

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

    • 方法详细信息

      • addFirst

        public void addFirst​(E e)
        在此双端队列的前面插入指定的元素。 由于deque是无界的，这种方法永远不会抛出IllegalStateException 。
        Specified by:
        addFirst在界面 Deque<E>
        参数
        e - 要添加的元素
        异常
        NullPointerException - 如果指定的元素为null

      • addLast

        public void addLast​(E e)
        在此双端队列的末尾插入指定的元素。 由于deque是无界的，这种方法永远不会抛出IllegalStateException 。

        此方法相当于add(E) 。

        Specified by:
        addLast在界面 Deque<E>
        参数
        e - 要添加的元素
        异常
        NullPointerException - 如果指定的元素为null

      • offerFirst

        public boolean offerFirst​(E e)
        在此双端队列的前面插入指定的元素。 由于双端队列无界，此方法永远不会返回false 。
        Specified by:
        offerFirst在界面 Deque<E>
        参数
        e - 要添加的元素
        结果
        true （由 Deque.offerFirst(E)指定）
        异常
        NullPointerException - 如果指定的元素为null

      • offerLast

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

        此方法相当于add(E) 。

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

      • getFirst

        public E getFirst()
        从界面复制的说明： Deque
        检索但不删除此双端队列的第一个元素。 此方法与peekFirst的不同之处仅在于，如果此双端队列为空，则会抛出异常。
        Specified by:
        getFirst在界面 Deque<E>
        结果
        这个双端队长
        异常
        NoSuchElementException - 如果此双端队列为空

      • getLast

        public E getLast()
        从界面复制的说明： Deque
        检索但不删除此双端队列的最后一个元素。 此方法与peekLast的不同之处仅在于，如果此双端队列为空，则会抛出异常。
        Specified by:
        getLast在界面 Deque<E>
        结果
        这个双端队员的尾巴
        异常
        NoSuchElementException - 如果此双端队列是空的

      • removeFirst

        public E removeFirst()
        从界面复制的说明： Deque
        检索并删除此双端队列的第一个元素。 此方法与pollFirst的不同之处仅在于，如果此双端队列为空，则会抛出异常。
        Specified by:
        removeFirst在界面 Deque<E>
        结果
        这个双端队长
        异常
        NoSuchElementException - 如果此双端队列是空的

      • removeLast

        public E removeLast()
        从界面复制的说明： Deque
        检索并删除此双端队列的最后一个元素。 此方法与pollLast的不同之处仅在于，如果此双端队列为空，则会抛出异常。
        Specified by:
        removeLast在界面 Deque<E>
        结果
        这个双端队员的尾巴
        异常
        NoSuchElementException - 如果此双端队列是空的

      • offer

        public boolean offer​(E e)
        在此双端队列的尾部插入指定的元素。 由于双端false ，此方法永远不会返回false 。
        Specified by:
        offer在界面 Deque<E>
        Specified by:
        offer在界面 Queue<E>
        参数
        e - 要添加的元素
        结果
        true （由 Queue.offer(E)指定）
        异常
        NullPointerException - 如果指定的元素为null

      • remove

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

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

        Specified by:
        remove在界面 Deque<E>
        Specified by:
        remove在界面 Queue<E>
        结果
        这个双端队列所代表的队列的头部
        异常
        NoSuchElementException - 如果此双端队列是空的

      • pop

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

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

        Specified by:
        pop在界面 Deque<E>
        结果
        此双端队列前面的元素（此双端队列表示的堆栈顶部）
        异常
        NoSuchElementException - 如果此双端队列为空

      • element

        public E element()
        从界面复制的说明： Deque
        检索但不删除此双端队列表示的队列的头部（换句话说，此双端队列的第一个元素）。 此方法与peek的不同之处仅在于，如果此双端队列为空，则会抛出异常。

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

        Specified by:
        element在界面 Deque<E>
        Specified by:
        element在界面 Queue<E>
        结果
        这个双端队列所代表的队列的头部
        异常
        NoSuchElementException - 如果此双端队列为空

      • push

        public void push​(E e)
        从界面复制的说明： Deque
        如果可以在不违反容量限制的情况下立即执行此操作， IllegalStateException到此双端队列表示的堆栈（换句话说，在此双端队列的头部），如果当前没有可用空间则抛出IllegalStateException 。

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

        Specified by:
        push在界面 Deque<E>
        参数
        e - 要推送的元素
        异常
        NullPointerException - 如果指定的元素为null且此双端队列不允许null元素

      • removeFirstOccurrence

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

      • removeLastOccurrence

        public boolean removeLastOccurrence​(Object o)
        从此双端队列中删除最后一次出现的指定元素。 如果双端队列不包含该元素，则不会更改。 更正式地，删除最后一个元素e ，使得o.equals(e) （如果存在这样的元素）。 如果此双端队列包含指定的元素，则返回true （或等效地，如果此双端队列因调用而更改）。
        Specified by:
        removeLastOccurrence ，界面 Deque<E>
        参数
        o - 要从此双端队列中删除的元素（如果存在）
        结果
        true如果deque包含指定的元素
        异常
        NullPointerException - 如果指定的元素为null

      • contains

        public boolean contains​(Object o)
        如果此双端队列包含指定的元素，则返回true 。 更正式的，返回true当且仅当此双端队列包含至少一个元素e o.equals(e) 。
        Specified by:
        contains在界面 Collection<E>
        Specified by:
        contains在界面 Deque<E>
        重写：
        contains在课程 AbstractCollection<E>
        参数
        o - 要测试此双端队列中存在的元素
        结果
        true如果此双端队列包含指定的元素

      • isEmpty

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

      • size

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

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

        Specified by:
        size在界面 Collection<E>
        Specified by:
        size在界面 Deque<E>
        结果
        此双端队列中的元素数量

      • remove

        public boolean remove​(Object o)
        从此双端队列中删除第一次出现的指定元素。 如果双端队列不包含该元素，则不会更改。 更正式地，删除第一个元素e ，使o.equals(e) （如果存在这样的元素）。 如果此双端队列包含指定的元素，则返回true （或等效地，如果此双端队列因调用而更改）。

        此方法相当于removeFirstOccurrence(Object) 。

        Specified by:
        remove在界面 Collection<E>
        Specified by:
        remove在界面 Deque<E>
        重写：
        remove在类 AbstractCollection<E>
        参数
        o - 要从此双端队列中删除的元素（如果存在）
        结果
        true如果deque包含指定的元素
        异常
        NullPointerException - 如果指定的元素为null

      • toArray

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

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

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

        Specified by:
        toArray在界面 Collection<E>
        重写：
        toArray在类 AbstractCollection<E>
        结果
        包含此双端队列中所有元素的数组

      • toArray

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

        如果此双端队列适合指定的数组，并且有空余空间（即，数组的元素数多于此双端队列），紧接在双端队列结束后的数组中的元素将设置为null 。

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

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

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

      • descendingIterator

        public Iterator<E> descendingIterator()
        以相反的顺序返回此双端队列中元素的迭代器。 元素将按从最后（尾部）到第一个（头部）的顺序返回。

        返回的迭代器是weakly consistent 。

        Specified by:
        descendingIterator在界面 Deque<E>
        结果
        以相反的顺序在此双端队列中的元素上的迭代器

      • removeIf

        public boolean removeIf​(Predicate<? super E> filter)
        从界面复制的说明： Collection
        删除此集合中满足给定谓词的所有元素。 在迭代期间或通过谓词抛出的错误或运行时异常被中继到调用者。
        Specified by:
        removeIf在界面 Collection<E>
        参数
        filter - 一个谓词，它返回 true表示要删除的元素
        结果
        true是否删除了任何元素
        异常
        NullPointerException - 如果指定的过滤器为null

      • forEach

        public void forEach​(Consumer<? super E> action)
        从界面复制的说明： Iterable
        对Iterable每个元素执行给定操作，直到处理Iterable所有元素或操作引发异常。 如果指定了该顺序，则按迭代顺序执行操作。 操作抛出的异常将转发给调用者。

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

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