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

Class ConcurrentLinkedQueue<E>

  • 参数类型
    E - 保存在此队列中的元素的类型
    All Implemented Interfaces:
    Serializable ， Iterable<E> ， Collection<E> ， Queue<E> 

    public class ConcurrentLinkedQueue<E>
extends AbstractQueue<E>
implements Queue<E>, Serializable
    基于链接节点的无界线程安全queue 。 这个队列排列元素FIFO（先进先出）。 队列的头部是队列中最长的元素。 队列的尾部是队列中最短时间的元素。 新元素插入队列的尾部，队列检索操作获取队列头部的元素。 A ConcurrentLinkedQueue是许多线程将共享对公共集合的访问的适当选择。 像大多数其他并发集合实现一样，此类不允许使用null元素。

    该实现采用基于Maged M.Michael和Michael L.Sci的Simple, Fast, and Practical Non-Blocking and Blocking Concurrent Queue Algorithms描述的有效的非阻塞算法。

    迭代器是弱一致的 ，返回的元素反映队列的状态在创建迭代器的某个时刻。 他们不抛出ConcurrentModificationException ，并可能与其他操作同时进行。 创建迭代器后包含在队列中的元素将被精确地返回一次。

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

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

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

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

    这个班是Java Collections Framework的会员。

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

    • 构造方法摘要

      构造方法  
      Constructor 描述
      ConcurrentLinkedQueue​()
      创建一个最初为空的 ConcurrentLinkedQueue 。
      ConcurrentLinkedQueue​(Collection<? extends E> c)
      创建一个 ConcurrentLinkedQueue最初包含给定集合的元素，以集合的迭代器的遍历顺序添加。

    • 方法摘要

      所有方法  接口方法  具体的方法 
      Modifier and Type 方法 描述
      boolean add​(E e)
      在该队列的尾部插入指定的元素。
      boolean addAll​(Collection<? extends E> c)
      按照指定集合的迭代器返回的顺序将指定集合中的所有元素追加到该队列的末尾。
      void clear​()
      从此队列中删除所有元素。
      boolean contains​(Object o)
      如果此队列包含指定的元素，则返回 true 。
      void forEach​(Consumer<? super E> action)
      对 Iterable每个元素执行给定的操作，直到所有元素都被处理或动作引发异常。
      boolean isEmpty​()
      如果此队列不包含元素，则返回 true 。
      Iterator<E> iterator​()
      以正确的顺序返回该队列中的元素的迭代器。
      boolean offer​(E e)
      在该队列的尾部插入指定的元素。
      E peek​()
      检索但不删除此队列的头，如果此队列为空，则返回 null 。
      E poll​()
      检索并删除此队列的头，如果此队列为空，则返回 null 。
      boolean remove​(Object o)
      从该队列中删除指定元素的单个实例（如果存在）。
      boolean removeAll​(Collection<?> c)
      删除指定集合中包含的所有此集合的元素（可选操作）。
      boolean removeIf​(Predicate<? super E> filter)
      删除满足给定谓词的此集合的所有元素。
      boolean retainAll​(Collection<?> c)
      仅保留此集合中包含在指定集合中的元素（可选操作）。
      int size​()
      返回此队列中的元素数。
      Spliterator<E> spliterator​()
      返回此队列中的元素Spliterator 。
      Object[] toArray​()
      以适当的顺序返回一个包含此队列中所有元素的数组。
      <T> T[] toArray​(T[] a)
      以适当的顺序返回包含此队列中所有元素的数组; 返回的数组的运行时类型是指定数组的运行时类型。
      String toString​()
      返回此集合的字符串表示形式。

    • 构造方法详细信息

      • ConcurrentLinkedQueue

        public ConcurrentLinkedQueue​()
        创建一个最初为空的 ConcurrentLinkedQueue 。

      • ConcurrentLinkedQueue

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

    • 方法详细信息

      • offer

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

      • poll

        public E poll​()
        说明从界面Queue复制
        检索并删除此队列的头，如果此队列为空，则返回 null 。
        Specified by:
        poll在接口 Queue<E>
        结果
        这个队列的头，或 null如果这个队列是空的

      • peek

        public E peek​()
        说明从界面Queue复制
        检索但不删除此队列的头，如果此队列为空，则返回 null 。
        Specified by:
        peek在接口 Queue<E>
        结果
        这个队列的头，或 null如果这个队列是空的

      • isEmpty

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

      • size

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

        请注意，与大多数集合不同，此方法不是一个常时操作。 由于这些队列的异步性质，确定当前的元素数需要O（n）遍历。 另外，如果在执行此方法期间添加或删除元素，则返回的结果可能不准确。 因此，这种方法在并发应用程序中通常不是很有用。

        Specified by:
        size在接口 Collection<E>
        Specified by:
        size在 AbstractCollection<E>
        结果
        此队列中的元素数

      • contains

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

      • remove

        public boolean remove​(Object o)
        从该队列中删除指定元素的单个实例（如果存在）。 更正式地，删除元素e ，使得o.equals(e) ，如果该队列包含一个或多个这样的元素。 如果此队列包含指定的元素（或等效地，如果此队列作为调用的结果而更改），则返回true 。
        Specified by:
        remove在接口 Collection<E>
        重写：
        remove在 AbstractCollection<E>
        参数
        o - 要从此队列中删除的元素（如果存在）
        结果
        true如果此队列由于调用而更改

      • toString

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

      • toArray

        public Object[] toArray​()
        以适当的顺序返回一个包含此队列中所有元素的数组。

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

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

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

      • toArray

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

        如果这个队列符合指定的数组空间（即阵列比此队列更多的元素），则队列结束后的数组中的元素设置为null 。

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

        假设x是一个已知只包含字符串的队列。 以下代码可用于将队列转储到新分配的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 - 如果指定的数组为空

      • removeIf

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

      • clear

        public void clear​()
        描述从类复制： AbstractQueue
        从此队列中删除所有元素。 此呼叫返回后队列将为空。

        这个实现反复调用poll直到它返回null 。

        Specified by:
        clear在接口 Collection<E>
        重写：
        clear在 AbstractQueue<E>

      • forEach

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

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

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