ArrayBlockingQueue (Java SE 9 & JDK 9 ) (original) (raw)

• • Constructor Summary

  Constructors

  Constructor	Description
  ArrayBlockingQueue​(int capacity)	Creates an ArrayBlockingQueue with the given (fixed) capacity and default access policy.
  ArrayBlockingQueue​(int capacity, boolean fair)	Creates an ArrayBlockingQueue with the given (fixed) capacity and the specified access policy.
  ArrayBlockingQueue​(int capacity, boolean fair,Collection<? extends E> c)	Creates an ArrayBlockingQueue with the given (fixed) capacity, the specified access policy and initially containing the elements of the given collection, added in traversal order of the collection's iterator.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  boolean	add​(E e)	Inserts the specified element at the tail of this queue if it is possible to do so immediately without exceeding the queue's capacity, returning true upon success and throwing anIllegalStateException if this queue is full.
  void	clear​()	Atomically removes all of the elements from this queue.
  boolean	contains​(Object o)	Returns true if this queue contains the specified element.
  int	drainTo​(Collection<? super E> c)	Removes all available elements from this queue and adds them to the given collection.
  int	drainTo​(Collection<? super E> c, int maxElements)	Removes at most the given number of available elements from this queue and adds them to the given collection.
  void	forEach​(Consumer<? super E> action)	Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception.
  Iterator<E>	iterator​()	Returns an iterator over the elements in this queue in proper sequence.
  boolean	offer​(E e)	Inserts the specified element at the tail of this queue if it is possible to do so immediately without exceeding the queue's capacity, returning true upon success and false if this queue is full.
  boolean	offer​(E e, long timeout,TimeUnit unit)	Inserts the specified element at the tail of this queue, waiting up to the specified wait time for space to become available if the queue is full.
  E	peek​()	Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.
  E	poll​()	Retrieves and removes the head of this queue, or returns null if this queue is empty.
  E	poll​(long timeout,TimeUnit unit)	Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.
  void	put​(E e)	Inserts the specified element at the tail of this queue, waiting for space to become available if the queue is full.
  int	remainingCapacity​()	Returns the number of additional elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking.
  boolean	remove​(Object o)	Removes a single instance of the specified element from this queue, if it is present.
  boolean	removeAll​(Collection<?> c)	Removes all of this collection's elements that are also contained in the specified collection (optional operation).
  boolean	removeIf​(Predicate<? super E> filter)	Removes all of the elements of this collection that satisfy the given predicate.
  boolean	retainAll​(Collection<?> c)	Retains only the elements in this collection that are contained in the specified collection (optional operation).
  int	size​()	Returns the number of elements in this queue.
  Spliterator<E>	spliterator​()	Returns a Spliterator over the elements in this queue.
  E	take​()	Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.
  Object[]	toArray​()	Returns an array containing all of the elements in this queue, in proper sequence.
  T[]	toArray​(T[] a)	Returns an array containing all of the elements in this queue, in proper sequence; the runtime type of the returned array is that of the specified array.
  String	toString​()	Returns a string representation of this collection.

     * ### Methods inherited from class java.util.[AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")  
     `[containsAll](../../../java/util/AbstractCollection.html#containsAll-java.util.Collection-), [isEmpty](../../../java/util/AbstractCollection.html#isEmpty--)`  
     * ### Methods inherited from class java.util.[AbstractQueue](../../../java/util/AbstractQueue.html "class in java.util")  
     `[addAll](../../../java/util/AbstractQueue.html#addAll-java.util.Collection-), [element](../../../java/util/AbstractQueue.html#element--), [remove](../../../java/util/AbstractQueue.html#remove--)`  
     * ### Methods inherited from interface java.util.[Collection](../../../java/util/Collection.html "interface in java.util")  
     `[addAll](../../../java/util/Collection.html#addAll-java.util.Collection-), [containsAll](../../../java/util/Collection.html#containsAll-java.util.Collection-), [equals](../../../java/util/Collection.html#equals-java.lang.Object-), [hashCode](../../../java/util/Collection.html#hashCode--), [isEmpty](../../../java/util/Collection.html#isEmpty--), [parallelStream](../../../java/util/Collection.html#parallelStream--), [stream](../../../java/util/Collection.html#stream--)`  
     * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`  
     * ### Methods inherited from interface java.util.[Queue](../../../java/util/Queue.html "interface in java.util")  
     `[element](../../../java/util/Queue.html#element--), [remove](../../../java/util/Queue.html#remove--)`

• • Constructor Detail

     * #### ArrayBlockingQueue  
     public ArrayBlockingQueue​(int capacity)  
     Creates an `ArrayBlockingQueue` with the given (fixed) capacity and default access policy.  
     Parameters:  
     `capacity` \- the capacity of this queue  
     Throws:  
     `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `capacity < 1`  
     * #### ArrayBlockingQueue  
     public ArrayBlockingQueue​(int capacity,  
                               boolean fair)  
     Creates an `ArrayBlockingQueue` with the given (fixed) capacity and the specified access policy.  
     Parameters:  
     `capacity` \- the capacity of this queue  
     `fair` \- if `true` then queue accesses for threads blocked on insertion or removal, are processed in FIFO order; if `false` the access order is unspecified.  
     Throws:  
     `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `capacity < 1`  
     * #### ArrayBlockingQueue  
     public ArrayBlockingQueue​(int capacity,  
                               boolean fair,  
                               [Collection](../../../java/util/Collection.html "interface in java.util")<? extends [E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")> c)  
     Creates an `ArrayBlockingQueue` with the given (fixed) capacity, the specified access policy and initially containing the elements of the given collection, added in traversal order of the collection's iterator.  
     Parameters:  
     `capacity` \- the capacity of this queue  
     `fair` \- if `true` then queue accesses for threads blocked on insertion or removal, are processed in FIFO order; if `false` the access order is unspecified.  
     `c` \- the collection of elements to initially contain  
     Throws:  
     `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `capacity` is less than`c.size()`, or less than 1.  
     `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified collection or any of its elements are null  

  • Method Detail

    * #### add  
    public boolean add​([E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue") e)  
    Inserts the specified element at the tail of this queue if it is possible to do so immediately without exceeding the queue's capacity, returning `true` upon success and throwing an`IllegalStateException` if this queue is full.  
    Specified by:  
    `[add](../../../java/util/concurrent/BlockingQueue.html#add-E-)` in interface `[BlockingQueue](../../../java/util/concurrent/BlockingQueue.html "interface in java.util.concurrent")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Specified by:  
    `[add](../../../java/util/Collection.html#add-E-)` in interface `[Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Specified by:  
    `[add](../../../java/util/Queue.html#add-E-)` in interface `[Queue](../../../java/util/Queue.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Overrides:  
    `[add](../../../java/util/AbstractQueue.html#add-E-)` in class `[AbstractQueue](../../../java/util/AbstractQueue.html "class in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Parameters:  
    `e` \- the element to add  
    Returns:  
    `true` (as specified by [Collection.add(E)](../../../java/util/Collection.html#add-E-))  
    Throws:  
    `[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang")` \- if this queue is full  
    `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified element is null  
    * #### offer  
    public boolean offer​([E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue") e)  
    Inserts the specified element at the tail of this queue if it is possible to do so immediately without exceeding the queue's capacity, returning `true` upon success and `false` if this queue is full. This method is generally preferable to method [add(E)](../../../java/util/concurrent/ArrayBlockingQueue.html#add-E-), which can fail to insert an element only by throwing an exception.  
    Specified by:  
    `[offer](../../../java/util/concurrent/BlockingQueue.html#offer-E-)` in interface `[BlockingQueue](../../../java/util/concurrent/BlockingQueue.html "interface in java.util.concurrent")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Specified by:  
    `[offer](../../../java/util/Queue.html#offer-E-)` in interface `[Queue](../../../java/util/Queue.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Parameters:  
    `e` \- the element to add  
    Returns:  
    `true` if the element was added to this queue, else`false`  
    Throws:  
    `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified element is null  
    * #### put  
    public void put​([E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue") e)  
             throws [InterruptedException](../../../java/lang/InterruptedException.html "class in java.lang")  
    Inserts the specified element at the tail of this queue, waiting for space to become available if the queue is full.  
    Specified by:  
    `[put](../../../java/util/concurrent/BlockingQueue.html#put-E-)` in interface `[BlockingQueue](../../../java/util/concurrent/BlockingQueue.html "interface in java.util.concurrent")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Parameters:  
    `e` \- the element to add  
    Throws:  
    `[InterruptedException](../../../java/lang/InterruptedException.html "class in java.lang")` \- if interrupted while waiting  
    `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified element is null  
    * #### offer  
    public boolean offer​([E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue") e,  
                         long timeout,  
                         [TimeUnit](../../../java/util/concurrent/TimeUnit.html "enum in java.util.concurrent") unit)  
                  throws [InterruptedException](../../../java/lang/InterruptedException.html "class in java.lang")  
    Inserts the specified element at the tail of this queue, waiting up to the specified wait time for space to become available if the queue is full.  
    Specified by:  
    `[offer](../../../java/util/concurrent/BlockingQueue.html#offer-E-long-java.util.concurrent.TimeUnit-)` in interface `[BlockingQueue](../../../java/util/concurrent/BlockingQueue.html "interface in java.util.concurrent")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Parameters:  
    `e` \- the element to add  
    `timeout` \- how long to wait before giving up, in units of`unit`  
    `unit` \- a `TimeUnit` determining how to interpret the`timeout` parameter  
    Returns:  
    `true` if successful, or `false` if the specified waiting time elapses before space is available  
    Throws:  
    `[InterruptedException](../../../java/lang/InterruptedException.html "class in java.lang")` \- if interrupted while waiting  
    `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified element is null  
    * #### poll  
    public [E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue") poll​()  
    Description copied from interface: `[Queue](../../../java/util/Queue.html#poll--)`  
    Retrieves and removes the head of this queue, or returns `null` if this queue is empty.  
    Specified by:  
    `[poll](../../../java/util/Queue.html#poll--)` in interface `[Queue](../../../java/util/Queue.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Returns:  
    the head of this queue, or `null` if this queue is empty  
    * #### take  
    public [E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue") take​()  
           throws [InterruptedException](../../../java/lang/InterruptedException.html "class in java.lang")  
    Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.  
    Specified by:  
    `[take](../../../java/util/concurrent/BlockingQueue.html#take--)` in interface `[BlockingQueue](../../../java/util/concurrent/BlockingQueue.html "interface in java.util.concurrent")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Returns:  
    the head of this queue  
    Throws:  
    `[InterruptedException](../../../java/lang/InterruptedException.html "class in java.lang")` \- if interrupted while waiting  
    * #### poll  
    public [E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue") poll​(long timeout,  
                  [TimeUnit](../../../java/util/concurrent/TimeUnit.html "enum in java.util.concurrent") unit)  
           throws [InterruptedException](../../../java/lang/InterruptedException.html "class in java.lang")  
    Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.  
    Specified by:  
    `[poll](../../../java/util/concurrent/BlockingQueue.html#poll-long-java.util.concurrent.TimeUnit-)` in interface `[BlockingQueue](../../../java/util/concurrent/BlockingQueue.html "interface in java.util.concurrent")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Parameters:  
    `timeout` \- how long to wait before giving up, in units of`unit`  
    `unit` \- a `TimeUnit` determining how to interpret the`timeout` parameter  
    Returns:  
    the head of this queue, or `null` if the specified waiting time elapses before an element is available  
    Throws:  
    `[InterruptedException](../../../java/lang/InterruptedException.html "class in java.lang")` \- if interrupted while waiting  
    * #### peek  
    public [E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue") peek​()  
    Description copied from interface: `[Queue](../../../java/util/Queue.html#peek--)`  
    Retrieves, but does not remove, the head of this queue, or returns `null` if this queue is empty.  
    Specified by:  
    `[peek](../../../java/util/Queue.html#peek--)` in interface `[Queue](../../../java/util/Queue.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Returns:  
    the head of this queue, or `null` if this queue is empty  
    * #### size  
    public int size​()  
    Returns the number of elements in this queue.  
    Specified by:  
    `[size](../../../java/util/Collection.html#size--)` in interface `[Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Specified by:  
    `[size](../../../java/util/AbstractCollection.html#size--)` in class `[AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Returns:  
    the number of elements in this queue  
    * #### remainingCapacity  
    public int remainingCapacity​()  
    Returns the number of additional elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking. This is always equal to the initial capacity of this queue less the current `size` of this queue.  
    Note that you _cannot_ always tell if an attempt to insert an element will succeed by inspecting `remainingCapacity` because it may be the case that another thread is about to insert or remove an element.  
    Specified by:  
    `[remainingCapacity](../../../java/util/concurrent/BlockingQueue.html#remainingCapacity--)` in interface `[BlockingQueue](../../../java/util/concurrent/BlockingQueue.html "interface in java.util.concurrent")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Returns:  
    the remaining capacity  
    * #### remove  
    public boolean remove​([Object](../../../java/lang/Object.html "class in java.lang") o)  
    Removes a single instance of the specified element from this queue, if it is present. More formally, removes an element `e` such that `o.equals(e)`, if this queue contains one or more such elements. Returns `true` if this queue contained the specified element (or equivalently, if this queue changed as a result of the call).  
    Removal of interior elements in circular array based queues is an intrinsically slow and disruptive operation, so should be undertaken only in exceptional circumstances, ideally only when the queue is known not to be accessible by other threads.  
    Specified by:  
    `[remove](../../../java/util/concurrent/BlockingQueue.html#remove-java.lang.Object-)` in interface `[BlockingQueue](../../../java/util/concurrent/BlockingQueue.html "interface in java.util.concurrent")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Specified by:  
    `[remove](../../../java/util/Collection.html#remove-java.lang.Object-)` in interface `[Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Overrides:  
    `[remove](../../../java/util/AbstractCollection.html#remove-java.lang.Object-)` in class `[AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Parameters:  
    `o` \- element to be removed from this queue, if present  
    Returns:  
    `true` if this queue changed as a result of the call  
    * #### contains  
    public boolean contains​([Object](../../../java/lang/Object.html "class in java.lang") o)  
    Returns `true` if this queue contains the specified element. More formally, returns `true` if and only if this queue contains at least one element `e` such that `o.equals(e)`.  
    Specified by:  
    `[contains](../../../java/util/concurrent/BlockingQueue.html#contains-java.lang.Object-)` in interface `[BlockingQueue](../../../java/util/concurrent/BlockingQueue.html "interface in java.util.concurrent")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Specified by:  
    `[contains](../../../java/util/Collection.html#contains-java.lang.Object-)` in interface `[Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Overrides:  
    `[contains](../../../java/util/AbstractCollection.html#contains-java.lang.Object-)` in class `[AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Parameters:  
    `o` \- object to be checked for containment in this queue  
    Returns:  
    `true` if this queue contains the specified element  
    * #### toArray  
    public [Object](../../../java/lang/Object.html "class in java.lang")[] toArray​()  
    Returns an array containing all of the elements in this queue, in proper sequence.  
    The returned array will be "safe" in that no references to it are maintained by this queue. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.  
    This method acts as bridge between array-based and collection-based APIs.  
    Specified by:  
    `[toArray](../../../java/util/Collection.html#toArray--)` in interface `[Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Overrides:  
    `[toArray](../../../java/util/AbstractCollection.html#toArray--)` in class `[AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Returns:  
    an array containing all of the elements in this queue  
    * #### toArray  
    public <T> T[] toArray​(T[] a)  
    Returns an array containing all of the elements in this queue, in proper sequence; the runtime type of the returned array is that of the specified array. If the queue fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this queue.  
    If this queue fits in the specified array with room to spare (i.e., the array has more elements than this queue), the element in the array immediately following the end of the queue is set to`null`.  
    Like the [toArray()](../../../java/util/concurrent/ArrayBlockingQueue.html#toArray--) method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.  
    Suppose `x` is a queue known to contain only strings. The following code can be used to dump the queue into a newly allocated array of `String`:  
     `String[] y = x.toArray(new String[0]);`  
     Note that `toArray(new Object[0])` is identical in function to`toArray()`.  
    Specified by:  
    `[toArray](../../../java/util/Collection.html#toArray-T:A-)` in interface `[Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Overrides:  
    `[toArray](../../../java/util/AbstractCollection.html#toArray-T:A-)` in class `[AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Type Parameters:  
    `T` \- the runtime type of the array to contain the collection  
    Parameters:  
    `a` \- the array into which the elements of the queue are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose  
    Returns:  
    an array containing all of the elements in this queue  
    Throws:  
    `[ArrayStoreException](../../../java/lang/ArrayStoreException.html "class in java.lang")` \- if the runtime type of the specified array is not a supertype of the runtime type of every element in this queue  
    `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified array is null  
    * #### toString  
    public [String](../../../java/lang/String.html "class in java.lang") toString​()  
    Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets (`"[]"`). Adjacent elements are separated by the characters`", "` (comma and space). Elements are converted to strings as by [String.valueOf(Object)](../../../java/lang/String.html#valueOf-java.lang.Object-).  
    Overrides:  
    `[toString](../../../java/util/AbstractCollection.html#toString--)` in class `[AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Returns:  
    a string representation of this collection  
    * #### clear  
    public void clear​()  
    Atomically removes all of the elements from this queue. The queue will be empty after this call returns.  
    Specified by:  
    `[clear](../../../java/util/Collection.html#clear--)` in interface `[Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Overrides:  
    `[clear](../../../java/util/AbstractQueue.html#clear--)` in class `[AbstractQueue](../../../java/util/AbstractQueue.html "class in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    * #### drainTo  
    public int drainTo​([Collection](../../../java/util/Collection.html "interface in java.util")<? super [E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")> c)  
    Removes all available elements from this queue and adds them to the given collection. This operation may be more efficient than repeatedly polling this queue. A failure encountered while attempting to add elements to collection `c` may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in`IllegalArgumentException`. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.  
    Specified by:  
    `[drainTo](../../../java/util/concurrent/BlockingQueue.html#drainTo-java.util.Collection-)` in interface `[BlockingQueue](../../../java/util/concurrent/BlockingQueue.html "interface in java.util.concurrent")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Parameters:  
    `c` \- the collection to transfer elements into  
    Returns:  
    the number of elements transferred  
    Throws:  
    `[UnsupportedOperationException](../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if addition of elements is not supported by the specified collection  
    `[ClassCastException](../../../java/lang/ClassCastException.html "class in java.lang")` \- if the class of an element of this queue prevents it from being added to the specified collection  
    `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified collection is null  
    `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the specified collection is this queue, or some property of an element of this queue prevents it from being added to the specified collection  
    * #### drainTo  
    public int drainTo​([Collection](../../../java/util/Collection.html "interface in java.util")<? super [E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")> c,  
                       int maxElements)  
    Removes at most the given number of available elements from this queue and adds them to the given collection. A failure encountered while attempting to add elements to collection `c` may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in`IllegalArgumentException`. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.  
    Specified by:  
    `[drainTo](../../../java/util/concurrent/BlockingQueue.html#drainTo-java.util.Collection-int-)` in interface `[BlockingQueue](../../../java/util/concurrent/BlockingQueue.html "interface in java.util.concurrent")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Parameters:  
    `c` \- the collection to transfer elements into  
    `maxElements` \- the maximum number of elements to transfer  
    Returns:  
    the number of elements transferred  
    Throws:  
    `[UnsupportedOperationException](../../../java/lang/UnsupportedOperationException.html "class in java.lang")` \- if addition of elements is not supported by the specified collection  
    `[ClassCastException](../../../java/lang/ClassCastException.html "class in java.lang")` \- if the class of an element of this queue prevents it from being added to the specified collection  
    `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified collection is null  
    `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the specified collection is this queue, or some property of an element of this queue prevents it from being added to the specified collection  
    * #### iterator  
    public [Iterator](../../../java/util/Iterator.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")> iterator​()  
    Returns an iterator over the elements in this queue in proper sequence. The elements will be returned in order from first (head) to last (tail).  
    The returned iterator is[_weakly consistent_](package-summary.html#Weakly).  
    Specified by:  
    `[iterator](../../../java/util/Collection.html#iterator--)` in interface `[Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Specified by:  
    `[iterator](../../../java/lang/Iterable.html#iterator--)` in interface `[Iterable](../../../java/lang/Iterable.html "interface in java.lang")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Specified by:  
    `[iterator](../../../java/util/AbstractCollection.html#iterator--)` in class `[AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Returns:  
    an iterator over the elements in this queue in proper sequence  
    * #### spliterator  
    public [Spliterator](../../../java/util/Spliterator.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")> spliterator​()  
    Specified by:  
    `[spliterator](../../../java/util/Collection.html#spliterator--)` in interface `[Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Specified by:  
    `[spliterator](../../../java/lang/Iterable.html#spliterator--)` in interface `[Iterable](../../../java/lang/Iterable.html "interface in java.lang")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Implementation Note:  
    The `Spliterator` implements `trySplit` to permit limited parallelism.  
    Returns:  
    a `Spliterator` over the elements in this queue  
    Since:  
    1.8  
    * #### forEach  
    public void forEach​([Consumer](../../../java/util/function/Consumer.html "interface in java.util.function")<? super [E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")> action)  
    Description copied from interface: `[Iterable](../../../java/lang/Iterable.html#forEach-java.util.function.Consumer-)`  
    Performs the given action for each element of the `Iterable` until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.  
     The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified a concurrent modification policy.  
    Specified by:  
    `[forEach](../../../java/lang/Iterable.html#forEach-java.util.function.Consumer-)` in interface `[Iterable](../../../java/lang/Iterable.html "interface in java.lang")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Parameters:  
    `action` \- The action to be performed for each element  
    Throws:  
    `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified action is null  
    * #### removeIf  
    public boolean removeIf​([Predicate](../../../java/util/function/Predicate.html "interface in java.util.function")<? super [E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")> filter)  
    Description copied from interface: `[Collection](../../../java/util/Collection.html#removeIf-java.util.function.Predicate-)`  
    Removes all of the elements of this collection that satisfy the given predicate. Errors or runtime exceptions thrown during iteration or by the predicate are relayed to the caller.  
    Specified by:  
    `[removeIf](../../../java/util/Collection.html#removeIf-java.util.function.Predicate-)` in interface `[Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Parameters:  
    `filter` \- a predicate which returns `true` for elements to be removed  
    Returns:  
    `true` if any elements were removed  
    Throws:  
    `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if the specified filter is null  
    * #### removeAll  
    public boolean removeAll​([Collection](../../../java/util/Collection.html "interface in java.util")<?> c)  
    Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.  
    Specified by:  
    `[removeAll](../../../java/util/Collection.html#removeAll-java.util.Collection-)` in interface `[Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Overrides:  
    `[removeAll](../../../java/util/AbstractCollection.html#removeAll-java.util.Collection-)` in class `[AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Parameters:  
    `c` \- collection containing elements to be removed from this collection  
    Returns:  
    `true` if this collection changed as a result of the call  
    Throws:  
    `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if this collection contains one or more null elements and the specified collection does not support null elements ([optional](#optional-restrictions)), or if the specified collection is null  
    See Also:  
    [AbstractCollection.remove(Object)](../../../java/util/AbstractCollection.html#remove-java.lang.Object-), [AbstractCollection.contains(Object)](../../../java/util/AbstractCollection.html#contains-java.lang.Object-)  
    * #### retainAll  
    public boolean retainAll​([Collection](../../../java/util/Collection.html "interface in java.util")<?> c)  
    Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.  
    Specified by:  
    `[retainAll](../../../java/util/Collection.html#retainAll-java.util.Collection-)` in interface `[Collection](../../../java/util/Collection.html "interface in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Overrides:  
    `[retainAll](../../../java/util/AbstractCollection.html#retainAll-java.util.Collection-)` in class `[AbstractCollection](../../../java/util/AbstractCollection.html "class in java.util")<[E](../../../java/util/concurrent/ArrayBlockingQueue.html "type parameter in ArrayBlockingQueue")>`  
    Parameters:  
    `c` \- collection containing elements to be retained in this collection  
    Returns:  
    `true` if this collection changed as a result of the call  
    Throws:  
    `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if this collection contains one or more null elements and the specified collection does not permit null elements ([optional](#optional-restrictions)), or if the specified collection is null  
    See Also:  
    [AbstractCollection.remove(Object)](../../../java/util/AbstractCollection.html#remove-java.lang.Object-), [AbstractCollection.contains(Object)](../../../java/util/AbstractCollection.html#contains-java.lang.Object-)