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

Class ArrayBlockingQueue<E>

  • 参数类型
    E - 此队列中保留的元素类型
    实现的所有接口
    Serializable ， Iterable<E> ， Collection<E> ， BlockingQueue<E> ， Queue<E> 
    public class ArrayBlockingQueue<E>extends AbstractQueue<E>implements BlockingQueue<E>, Serializable
    由数组支持的有界blocking queue 。 此队列命令元素FIFO（先进先出）。 队列的头部是队列中最长时间的元素。 队列的尾部是队列中最短时间的元素。 在队列的尾部插入新元素，队列检索操作获取队列头部的元素。

    这是一个经典的“有界缓冲区”，其中固定大小的数组包含由生产者插入并由消费者提取的元素。 创建后，无法更改容量。 尝试将put元素转换为完整队列将导致操作阻塞; 尝试take空队列中的元素将同样阻止。

    此类支持用于排序等待生产者和消费者线程的可选公平策略。 默认情况下，不保证此顺序。 但是，使用公平性设置为true构造的队列以FIFO顺序授予线程访问权限。 公平性通常会降低吞吐量，但会降低可变性并避免饥饿。

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

    此类是Java Collections Framework的成员。

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

    • 构造方法摘要

      构造方法  
      构造器 描述
      ArrayBlockingQueue​(int capacity)
      创建具有给定（固定）容量和默认访问策略的 ArrayBlockingQueue 。
      ArrayBlockingQueue​(int capacity, boolean fair)
      创建具有给定（固定）容量和指定访问策略的 ArrayBlockingQueue 。
      ArrayBlockingQueue​(int capacity, boolean fair, Collection<? extends E> c)
      创建具有给定（固定）容量的 ArrayBlockingQueue ，指定的访问策略并最初包含给定集合的元素，以集合的迭代器的遍历顺序添加。

    • 方法摘要

      所有方法  实例方法 具体的方法 
      变量和类型 方法 描述
      boolean add​(E e)
      在插入此队列的尾部，如果有可能立即这样做不超过该队列的容量，返回指定的元素 true成功时与抛出 IllegalStateException如果此队列已满。
      void clear()
      以原子方式删除此队列中的所有元素。
      boolean contains​(Object o)
      如果此队列包含指定的元素，则返回 true 。
      int drainTo​(Collection<? super E> c)
      从此队列中删除所有可用元素，并将它们添加到给定集合中。
      int drainTo​(Collection<? super E> c, int maxElements)
      从该队列中删除最多给定数量的可用元素，并将它们添加到给定集合中。
      void forEach​(Consumer<? super E> action)
      对 Iterable每个元素执行给定操作，直到处理 Iterable所有元素或操作引发异常。
      Iterator<E> iterator()
      以适当的顺序返回此队列中元素的迭代器。
      boolean offer​(E e)
      插入指定的元素在这个队列的尾部，如果有可能立即这样做不超过该队列的容量，返回 true在成功和 false如果此队列已满。
      boolean offer​(E e, long timeout, TimeUnit unit)
      将指定的元素插入此队列的尾部，等待指定的等待时间，以便在队列已满时空间可用。
      void put​(E e)
      将指定元素插入此队列的尾部，等待队列已满时空间可用。
      int remainingCapacity()
      返回理想情况下（在没有内存或资源约束的情况下）此队列可以无阻塞地接受的其他元素的数量。
      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)
      以适当的顺序返回包含此队列中所有元素的数组; 返回数组的运行时类型是指定数组的运行时类型。

    • 构造方法详细信息

      • ArrayBlockingQueue

        public ArrayBlockingQueue​(int capacity)
        创建具有给定（固定）容量和默认访问策略的 ArrayBlockingQueue 。
        参数
        capacity - 此队列的容量
        异常
        IllegalArgumentException - 如果 capacity < 1

      • ArrayBlockingQueue

        public ArrayBlockingQueue​(int capacity,                          boolean fair)
        创建具有给定（固定）容量和指定访问策略的 ArrayBlockingQueue 。
        参数
        capacity - 此队列的容量
        fair - 如果true则插入或删除时阻塞的线程的队列访问true FIFO顺序处理; 如果false未指定访问顺序。
        异常
        IllegalArgumentException - 如果 capacity < 1

      • ArrayBlockingQueue

        public ArrayBlockingQueue​(int capacity,                          boolean fair,                          Collection<? extends E> c)
        创建具有给定（固定）容量的 ArrayBlockingQueue ，指定的访问策略并最初包含给定集合的元素，以集合的迭代器的遍历顺序添加。
        参数
        capacity - 此队列的容量
        fair - 如果true则插入或删除时阻塞的线程的队列访问true FIFO顺序处理; 如果false未指定访问顺序。
        c - 最初包含的元素集合
        异常
        IllegalArgumentException - 如果 capacity小于 c.size() ，或小于1。
        NullPointerException - 如果指定的集合或其任何元素为null

    • 方法详细信息

      • offer

        public boolean offer​(E e)
        插入指定的元素在这个队列的尾部，如果有可能立即这样做不超过该队列的容量，返回true在成功和false如果此队列已满。 该方法通常优于方法add(E) ，其仅通过抛出异常而无法插入元素。
        Specified by:
        offer在界面 BlockingQueue<E>
        Specified by:
        offer在界面 Queue<E>
        参数
        e - 要添加的元素
        结果
        true如果元素已添加到此队列， false
        异常
        NullPointerException - 如果指定的元素为null

      • offer

        public boolean offer​(E e,                     long timeout,                     TimeUnit unit)              throws InterruptedException
        将指定的元素插入此队列的尾部，等待指定的等待时间，以便在队列已满时空间可用。
        Specified by:
        offer在界面 BlockingQueue<E>
        参数
        e - 要添加的元素
        timeout - 放弃前等待多长时间，单位为 unit
        unit -一个 TimeUnit确定如何解释 timeout参数
        结果
        true如果成功，或 false如果在空间可用之前经过了指定的等待时间
        异常
        InterruptedException - 如果在等待时中断
        NullPointerException - 如果指定的元素为null

      • size

        public int size()
        返回此队列中的元素数。
        Specified by:
        size在界面 Collection<E>
        结果
        此队列中的元素数

      • remainingCapacity

        public int remainingCapacity()
        返回理想情况下（在没有内存或资源约束的情况下）此队列可以无阻塞地接受的其他元素的数量。 这总是等于此队列的初始容量减去此队列的当前size 。

        请注意，您不能总是通过检查remainingCapacity来判断插入元素的尝试是否成功，因为可能是另一个线程即将插入或删除元素的情况。

        Specified by:
        remainingCapacity在界面 BlockingQueue<E>
        结果
        剩余的容量

      • remove

        public boolean remove​(Object o)
        从此队列中删除指定元素的单个实例（如果存在）。 更正式地，如果此队列包含一个或多个此类元素，则删除元素e ，使得o.equals(e) 。 如果此队列包含指定的元素，则返回true （或等效地，如果此队列因调用而更改）。

        在基于循环阵列的队列中删除内部元素是一种本质上缓慢且具有破坏性的操作，因此只应在特殊情况下进行，理想情况下，只有在知道队列不被其他线程访问时才能进行。

        Specified by:
        remove在界面 BlockingQueue<E>
        Specified by:
        remove ，界面 Collection<E>
        重写：
        remove在类 AbstractCollection<E>
        参数
        o - 要从此队列中删除的元素（如果存在）
        结果
        true如果此队列因调用而更改

      • contains

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

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

      • clear

        public void clear()
        以原子方式删除此队列中的所有元素。 此调用返回后，队列将为空。
        Specified by:
        clear在界面 Collection<E>
        重写：
        clear在类 AbstractQueue<E>

      • drainTo

        public int drainTo​(Collection<? super E> c)
        从界面复制的说明： BlockingQueue
        从此队列中删除所有可用元素，并将它们添加到给定集合中。 此操作可能比重复轮询此队列更有效。 尝试向集合c添加元素时遇到的故障可能导致在抛出关联的异常时元素既不在集合中，也不在集合中。 尝试将队列排入自身会导致IllegalArgumentException 。 此外，如果在操作正在进行时修改了指定的集合，则此操作的行为是不确定的。
        Specified by:
        drainTo在界面 BlockingQueue<E>
        参数
        c - 将元素转移到的集合
        结果
        转移的元素数量
        异常
        UnsupportedOperationException - 如果指定的集合不支持添加元素
        ClassCastException - 如果此队列的元素的类阻止将其添加到指定的集合中
        NullPointerException - 如果指定的集合为null
        IllegalArgumentException - 如果指定的集合是此队列，或此队列的某个元素的某些属性阻止将其添加到指定的集合

      • drainTo

        public int drainTo​(Collection<? super E> c,                   int maxElements)
        从界面复制的说明： BlockingQueue
        从该队列中删除最多给定数量的可用元素，并将它们添加到给定集合中。 尝试向集合c添加元素时遇到的故障可能导致在抛出关联的异常时元素既不在集合中，也不在集合中。 尝试将队列排入自身会导致IllegalArgumentException 。 此外，如果在操作正在进行时修改了指定的集合，则此操作的行为是不确定的。
        Specified by:
        drainTo在界面 BlockingQueue<E>
        参数
        c - 将元素转移到的集合
        maxElements - 要传输的最大元素数
        结果
        转移的元素数量
        异常
        UnsupportedOperationException - 如果指定集合不支持添加元素
        ClassCastException - 如果此队列的元素的类阻止将其添加到指定的集合中
        NullPointerException - 如果指定的集合为null
        IllegalArgumentException - 如果指定的集合是此队列，或此队列的某个元素的某些属性阻止将其添加到指定的集合

      • forEach

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

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

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

      • removeIf

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