java.util.concurrent
Class ArrayBlockingQueue<E>

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.util.AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
      extended by java.util.AbstractQueue sample code for java.util.AbstractQueue definition code for java.util.AbstractQueue <E>
          extended by java.util.concurrent.ArrayBlockingQueue<E>
Type Parameters:
E - the type of elements held in this collection
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Iterable sample code for java.lang.Iterable definition code for java.lang.Iterable <E>, Collection sample code for java.util.Collection definition code for java.util.Collection <E>, BlockingQueue sample code for java.util.concurrent.BlockingQueue definition code for java.util.concurrent.BlockingQueue <E>, Queue sample code for java.util.Queue definition code for java.util.Queue <E>

public class ArrayBlockingQueue<E>
extends AbstractQueue sample code for java.util.AbstractQueue definition code for java.util.AbstractQueue <E>
implements BlockingQueue sample code for java.util.concurrent.BlockingQueue definition code for java.util.concurrent.BlockingQueue <E>, Serializable sample code for java.io.Serializable definition code for java.io.Serializable

A bounded blocking queue sample code for java.util.concurrent.BlockingQueue definition code for java.util.concurrent.BlockingQueue backed by an array. This queue orders elements FIFO (first-in-first-out). The head of the queue is that element that has been on the queue the longest time. The tail of the queue is that element that has been on the queue the shortest time. New elements are inserted at the tail of the queue, and the queue retrieval operations obtain elements at the head of the queue.

This is a classic "bounded buffer", in which a fixed-sized array holds elements inserted by producers and extracted by consumers. Once created, the capacity cannot be increased. Attempts to put an element to a full queue will result in the put operation blocking; attempts to retrieve an element from an empty queue will similarly block.

This class supports an optional fairness policy for ordering waiting producer and consumer threads. By default, this ordering is not guaranteed. However, a queue constructed with fairness set to true grants threads access in FIFO order. Fairness generally decreases throughput but reduces variability and avoids starvation.

This class and its iterator implement all of the optional methods of the Collection sample code for java.util.Collection definition code for java.util.Collection and Iterator sample code for java.util.Iterator definition code for java.util.Iterator interfaces.

This class is a member of the Java Collections Framework.

Since:
1.5
See Also:
Serialized Form

Constructor Summary
ArrayBlockingQueue sample code for java.util.concurrent.ArrayBlockingQueue.ArrayBlockingQueue(int) definition code for java.util.concurrent.ArrayBlockingQueue.ArrayBlockingQueue(int) (int capacity)
          Creates an ArrayBlockingQueue with the given (fixed) capacity and default access policy.
ArrayBlockingQueue sample code for java.util.concurrent.ArrayBlockingQueue.ArrayBlockingQueue(int, boolean) definition code for java.util.concurrent.ArrayBlockingQueue.ArrayBlockingQueue(int, boolean) (int capacity, boolean fair)
          Creates an ArrayBlockingQueue with the given (fixed) capacity and the specified access policy.
ArrayBlockingQueue sample code for java.util.concurrent.ArrayBlockingQueue.ArrayBlockingQueue(int, boolean, java.util.Collection) definition code for java.util.concurrent.ArrayBlockingQueue.ArrayBlockingQueue(int, boolean, java.util.Collection) (int capacity, boolean fair, Collection sample code for java.util.Collection definition code for java.util.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
 void clear sample code for java.util.concurrent.ArrayBlockingQueue.clear() definition code for java.util.concurrent.ArrayBlockingQueue.clear() ()
          Atomically removes all of the elements from this queue.
 boolean contains sample code for java.util.concurrent.ArrayBlockingQueue.contains(java.lang.Object) definition code for java.util.concurrent.ArrayBlockingQueue.contains(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  o)
          Returns true if this collection contains the specified element.
 int drainTo sample code for java.util.concurrent.ArrayBlockingQueue.drainTo(java.util.Collection) definition code for java.util.concurrent.ArrayBlockingQueue.drainTo(java.util.Collection) (Collection sample code for java.util.Collection definition code for java.util.Collection <? super E> c)
          Removes all available elements from this queue and adds them into the given collection.
 int drainTo sample code for java.util.concurrent.ArrayBlockingQueue.drainTo(java.util.Collection, int) definition code for java.util.concurrent.ArrayBlockingQueue.drainTo(java.util.Collection, int) (Collection sample code for java.util.Collection definition code for java.util.Collection <? super E> c, int maxElements)
          Removes at most the given number of available elements from this queue and adds them into the given collection.
 Iterator sample code for java.util.Iterator definition code for java.util.Iterator <E> iterator sample code for java.util.concurrent.ArrayBlockingQueue.iterator() definition code for java.util.concurrent.ArrayBlockingQueue.iterator() ()
          Returns an iterator over the elements in this queue in proper sequence.
 boolean offer sample code for java.util.concurrent.ArrayBlockingQueue.offer(E) definition code for java.util.concurrent.ArrayBlockingQueue.offer(E) (E o)
          Inserts the specified element at the tail of this queue if possible, returning immediately if this queue is full.
 boolean offer sample code for java.util.concurrent.ArrayBlockingQueue.offer(E, long, java.util.concurrent.TimeUnit) definition code for java.util.concurrent.ArrayBlockingQueue.offer(E, long, java.util.concurrent.TimeUnit) (E o, long timeout, TimeUnit sample code for java.util.concurrent.TimeUnit definition code for java.util.concurrent.TimeUnit  unit)
          Inserts the specified element at the tail of this queue, waiting if necessary up to the specified wait time for space to become available.
 E peek sample code for java.util.concurrent.ArrayBlockingQueue.peek() definition code for java.util.concurrent.ArrayBlockingQueue.peek() ()
          Retrieves, but does not remove, the head of this queue, returning null if this queue is empty.
 E poll sample code for java.util.concurrent.ArrayBlockingQueue.poll() definition code for java.util.concurrent.ArrayBlockingQueue.poll() ()
          Retrieves and removes the head of this queue, or null if this queue is empty.
 E poll sample code for java.util.concurrent.ArrayBlockingQueue.poll(long, java.util.concurrent.TimeUnit) definition code for java.util.concurrent.ArrayBlockingQueue.poll(long, java.util.concurrent.TimeUnit) (long timeout, TimeUnit sample code for java.util.concurrent.TimeUnit definition code for java.util.concurrent.TimeUnit  unit)
          Retrieves and removes the head of this queue, waiting if necessary up to the specified wait time if no elements are present on this queue.
 void put sample code for java.util.concurrent.ArrayBlockingQueue.put(E) definition code for java.util.concurrent.ArrayBlockingQueue.put(E) (E o)
          Adds the specified element to the tail of this queue, waiting if necessary for space to become available.
 int remainingCapacity sample code for java.util.concurrent.ArrayBlockingQueue.remainingCapacity() definition code for java.util.concurrent.ArrayBlockingQueue.remainingCapacity() ()
          Returns the number of elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking.
 boolean remove sample code for java.util.concurrent.ArrayBlockingQueue.remove(java.lang.Object) definition code for java.util.concurrent.ArrayBlockingQueue.remove(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  o)
          Removes a single instance of the specified element from this queue, if it is present.
 int size sample code for java.util.concurrent.ArrayBlockingQueue.size() definition code for java.util.concurrent.ArrayBlockingQueue.size() ()
          Returns the number of elements in this queue.
 E take sample code for java.util.concurrent.ArrayBlockingQueue.take() definition code for java.util.concurrent.ArrayBlockingQueue.take() ()
          Retrieves and removes the head of this queue, waiting if no elements are present on this queue.
 Object sample code for java.lang.Object definition code for java.lang.Object [] toArray sample code for java.util.concurrent.ArrayBlockingQueue.toArray() definition code for java.util.concurrent.ArrayBlockingQueue.toArray() ()
          Returns an array containing all of the elements in this collection.
<T> T[]
toArray sample code for java.util.concurrent.ArrayBlockingQueue.toArray(T[]) definition code for java.util.concurrent.ArrayBlockingQueue.toArray(T[]) (T[] a)
          Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.util.concurrent.ArrayBlockingQueue.toString() definition code for java.util.concurrent.ArrayBlockingQueue.toString() ()
          Returns a string representation of this collection.
 
Methods inherited from class java.util.AbstractQueue sample code for java.util.AbstractQueue definition code for java.util.AbstractQueue
add sample code for java.util.AbstractQueue.add(E) definition code for java.util.AbstractQueue.add(E) , addAll sample code for java.util.AbstractQueue.addAll(java.util.Collection) definition code for java.util.AbstractQueue.addAll(java.util.Collection) , element sample code for java.util.AbstractQueue.element() definition code for java.util.AbstractQueue.element() , remove sample code for java.util.AbstractQueue.remove() definition code for java.util.AbstractQueue.remove()
 
Methods inherited from class java.util.AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection
containsAll sample code for java.util.AbstractCollection.containsAll(java.util.Collection) definition code for java.util.AbstractCollection.containsAll(java.util.Collection) , isEmpty sample code for java.util.AbstractCollection.isEmpty() definition code for java.util.AbstractCollection.isEmpty() , removeAll sample code for java.util.AbstractCollection.removeAll(java.util.Collection) definition code for java.util.AbstractCollection.removeAll(java.util.Collection) , retainAll sample code for java.util.AbstractCollection.retainAll(java.util.Collection) definition code for java.util.AbstractCollection.retainAll(java.util.Collection)
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 
Methods inherited from interface java.util.concurrent.BlockingQueue sample code for java.util.concurrent.BlockingQueue definition code for java.util.concurrent.BlockingQueue
add sample code for java.util.concurrent.BlockingQueue.add(E) definition code for java.util.concurrent.BlockingQueue.add(E)
 
Methods inherited from interface java.util.Queue sample code for java.util.Queue definition code for java.util.Queue
element sample code for java.util.Queue.element() definition code for java.util.Queue.element() , remove sample code for java.util.Queue.remove() definition code for java.util.Queue.remove()
 
Methods inherited from interface java.util.Collection sample code for java.util.Collection definition code for java.util.Collection
addAll sample code for java.util.Collection.addAll(java.util.Collection) definition code for java.util.Collection.addAll(java.util.Collection) , containsAll sample code for java.util.Collection.containsAll(java.util.Collection) definition code for java.util.Collection.containsAll(java.util.Collection) , equals sample code for java.util.Collection.equals(java.lang.Object) definition code for java.util.Collection.equals(java.lang.Object) , hashCode sample code for java.util.Collection.hashCode() definition code for java.util.Collection.hashCode() , isEmpty sample code for java.util.Collection.isEmpty() definition code for java.util.Collection.isEmpty() , removeAll sample code for java.util.Collection.removeAll(java.util.Collection) definition code for java.util.Collection.removeAll(java.util.Collection) , retainAll sample code for java.util.Collection.retainAll(java.util.Collection) definition code for java.util.Collection.retainAll(java.util.Collection)
 

Constructor Detail

ArrayBlockingQueue sample code for java.util.concurrent.ArrayBlockingQueue(int) definition code for java.util.concurrent.ArrayBlockingQueue(int)

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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if capacity is less than 1

ArrayBlockingQueue sample code for java.util.concurrent.ArrayBlockingQueue(int, boolean) definition code for java.util.concurrent.ArrayBlockingQueue(int, boolean)

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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if capacity is less than 1

ArrayBlockingQueue sample code for java.util.concurrent.ArrayBlockingQueue(int, boolean, java.util.Collection<? extends E>) definition code for java.util.concurrent.ArrayBlockingQueue(int, boolean, java.util.Collection<? extends E>)

public ArrayBlockingQueue(int capacity,
                          boolean fair,
                          Collection sample code for java.util.Collection definition code for java.util.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.

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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if capacity is less than c.size(), or less than 1.
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if c or any element within it is null
Method Detail

offer sample code for java.util.concurrent.ArrayBlockingQueue.offer(E) definition code for java.util.concurrent.ArrayBlockingQueue.offer(E)

public boolean offer(E o)
Inserts the specified element at the tail of this queue if possible, returning immediately if this queue is full.

Specified by:
offer sample code for java.util.concurrent.BlockingQueue.offer(E) definition code for java.util.concurrent.BlockingQueue.offer(E) in interface BlockingQueue sample code for java.util.concurrent.BlockingQueue definition code for java.util.concurrent.BlockingQueue <E>
Specified by:
offer sample code for java.util.Queue.offer(E) definition code for java.util.Queue.offer(E) in interface Queue sample code for java.util.Queue definition code for java.util.Queue <E>
Parameters:
o - the element to add.
Returns:
true if it was possible to add the element to this queue, else false
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if the specified element is null

offer sample code for java.util.concurrent.ArrayBlockingQueue.offer(E, long, java.util.concurrent.TimeUnit) definition code for java.util.concurrent.ArrayBlockingQueue.offer(E, long, java.util.concurrent.TimeUnit)

public boolean offer(E o,
                     long timeout,
                     TimeUnit sample code for java.util.concurrent.TimeUnit definition code for java.util.concurrent.TimeUnit  unit)
              throws InterruptedException sample code for java.lang.InterruptedException definition code for java.lang.InterruptedException 
Inserts the specified element at the tail of this queue, waiting if necessary up to the specified wait time for space to become available.

Specified by:
offer sample code for java.util.concurrent.BlockingQueue.offer(E, long, java.util.concurrent.TimeUnit) definition code for java.util.concurrent.BlockingQueue.offer(E, long, java.util.concurrent.TimeUnit) in interface BlockingQueue sample code for java.util.concurrent.BlockingQueue definition code for java.util.concurrent.BlockingQueue <E>
Parameters:
o - 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 sample code for java.lang.InterruptedException definition code for java.lang.InterruptedException - if interrupted while waiting.
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if the specified element is null.

poll sample code for java.util.concurrent.ArrayBlockingQueue.poll() definition code for java.util.concurrent.ArrayBlockingQueue.poll()

public E poll()
Description copied from interface: Queue sample code for java.util.Queue.poll() definition code for java.util.Queue.poll()
Retrieves and removes the head of this queue, or null if this queue is empty.

Specified by:
poll sample code for java.util.Queue.poll() definition code for java.util.Queue.poll() in interface Queue sample code for java.util.Queue definition code for java.util.Queue <E>
Returns:
the head of this queue, or null if this queue is empty.

poll sample code for java.util.concurrent.ArrayBlockingQueue.poll(long, java.util.concurrent.TimeUnit) definition code for java.util.concurrent.ArrayBlockingQueue.poll(long, java.util.concurrent.TimeUnit)

public E poll(long timeout,
              TimeUnit sample code for java.util.concurrent.TimeUnit definition code for java.util.concurrent.TimeUnit  unit)
       throws InterruptedException sample code for java.lang.InterruptedException definition code for java.lang.InterruptedException 
Description copied from interface: BlockingQueue sample code for java.util.concurrent.BlockingQueue.poll(long, java.util.concurrent.TimeUnit) definition code for java.util.concurrent.BlockingQueue.poll(long, java.util.concurrent.TimeUnit)
Retrieves and removes the head of this queue, waiting if necessary up to the specified wait time if no elements are present on this queue.

Specified by:
poll sample code for java.util.concurrent.BlockingQueue.poll(long, java.util.concurrent.TimeUnit) definition code for java.util.concurrent.BlockingQueue.poll(long, java.util.concurrent.TimeUnit) in interface BlockingQueue sample code for java.util.concurrent.BlockingQueue definition code for java.util.concurrent.BlockingQueue <E>
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 present.
Throws:
InterruptedException sample code for java.lang.InterruptedException definition code for java.lang.InterruptedException - if interrupted while waiting.

remove sample code for java.util.concurrent.ArrayBlockingQueue.remove(java.lang.Object) definition code for java.util.concurrent.ArrayBlockingQueue.remove(java.lang.Object)

public boolean remove(Object sample code for java.lang.Object definition code for java.lang.Object  o)
Removes a single instance of the specified element from this queue, if it is present.

Specified by:
remove sample code for java.util.Collection.remove(java.lang.Object) definition code for java.util.Collection.remove(java.lang.Object) in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Overrides:
remove sample code for java.util.AbstractCollection.remove(java.lang.Object) definition code for java.util.AbstractCollection.remove(java.lang.Object) in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Parameters:
o - element to be removed from this collection, if present.
Returns:
true if the collection contained the specified element.

peek sample code for java.util.concurrent.ArrayBlockingQueue.peek() definition code for java.util.concurrent.ArrayBlockingQueue.peek()

public E peek()
Description copied from interface: Queue sample code for java.util.Queue.peek() definition code for java.util.Queue.peek()
Retrieves, but does not remove, the head of this queue, returning null if this queue is empty.

Specified by:
peek sample code for java.util.Queue.peek() definition code for java.util.Queue.peek() in interface Queue sample code for java.util.Queue definition code for java.util.Queue <E>
Returns:
the head of this queue, or null if this queue is empty.

take sample code for java.util.concurrent.ArrayBlockingQueue.take() definition code for java.util.concurrent.ArrayBlockingQueue.take()

public E take()
       throws InterruptedException sample code for java.lang.InterruptedException definition code for java.lang.InterruptedException 
Description copied from interface: BlockingQueue sample code for java.util.concurrent.BlockingQueue.take() definition code for java.util.concurrent.BlockingQueue.take()
Retrieves and removes the head of this queue, waiting if no elements are present on this queue.

Specified by:
take sample code for java.util.concurrent.BlockingQueue.take() definition code for java.util.concurrent.BlockingQueue.take() in interface BlockingQueue sample code for java.util.concurrent.BlockingQueue definition code for java.util.concurrent.BlockingQueue <E>
Returns:
the head of this queue
Throws:
InterruptedException sample code for java.lang.InterruptedException definition code for java.lang.InterruptedException - if interrupted while waiting.

put sample code for java.util.concurrent.ArrayBlockingQueue.put(E) definition code for java.util.concurrent.ArrayBlockingQueue.put(E)

public void put(E o)
         throws InterruptedException sample code for java.lang.InterruptedException definition code for java.lang.InterruptedException 
Adds the specified element to the tail of this queue, waiting if necessary for space to become available.

Specified by:
put sample code for java.util.concurrent.BlockingQueue.put(E) definition code for java.util.concurrent.BlockingQueue.put(E) in interface BlockingQueue sample code for java.util.concurrent.BlockingQueue definition code for java.util.concurrent.BlockingQueue <E>
Parameters:
o - the element to add
Throws:
InterruptedException sample code for java.lang.InterruptedException definition code for java.lang.InterruptedException - if interrupted while waiting.
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if the specified element is null.

size sample code for java.util.concurrent.ArrayBlockingQueue.size() definition code for java.util.concurrent.ArrayBlockingQueue.size()

public int size()
Returns the number of elements in this queue.

Specified by:
size sample code for java.util.Collection.size() definition code for java.util.Collection.size() in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
size sample code for java.util.AbstractCollection.size() definition code for java.util.AbstractCollection.size() in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Returns:
the number of elements in this queue.

remainingCapacity sample code for java.util.concurrent.ArrayBlockingQueue.remainingCapacity() definition code for java.util.concurrent.ArrayBlockingQueue.remainingCapacity()

public int remainingCapacity()
Returns the number of 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 add an element will succeed by inspecting remainingCapacity because it may be the case that a waiting consumer is ready to take an element out of an otherwise full queue.

Specified by:
remainingCapacity sample code for java.util.concurrent.BlockingQueue.remainingCapacity() definition code for java.util.concurrent.BlockingQueue.remainingCapacity() in interface BlockingQueue sample code for java.util.concurrent.BlockingQueue definition code for java.util.concurrent.BlockingQueue <E>
Returns:
the remaining capacity

contains sample code for java.util.concurrent.ArrayBlockingQueue.contains(java.lang.Object) definition code for java.util.concurrent.ArrayBlockingQueue.contains(java.lang.Object)

public boolean contains(Object sample code for java.lang.Object definition code for java.lang.Object  o)
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.contains(java.lang.Object) definition code for java.util.AbstractCollection.contains(java.lang.Object)
Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).

This implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element.

Specified by:
contains sample code for java.util.Collection.contains(java.lang.Object) definition code for java.util.Collection.contains(java.lang.Object) in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Overrides:
contains sample code for java.util.AbstractCollection.contains(java.lang.Object) definition code for java.util.AbstractCollection.contains(java.lang.Object) in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Parameters:
o - object to be checked for containment in this collection.
Returns:
true if this collection contains the specified element.

toArray sample code for java.util.concurrent.ArrayBlockingQueue.toArray() definition code for java.util.concurrent.ArrayBlockingQueue.toArray()

public Object sample code for java.lang.Object definition code for java.lang.Object [] toArray()
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.toArray() definition code for java.util.AbstractCollection.toArray()
Returns an array containing all of the elements in this collection. If the collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array will be "safe" in that no references to it are maintained by the collection. (In other words, this method must allocate a new array even if the collection is backed by an Array). The caller is thus free to modify the returned array.

This implementation allocates the array to be returned, and iterates over the elements in the collection, storing each object reference in the next consecutive element of the array, starting with element 0.

Specified by:
toArray sample code for java.util.Collection.toArray() definition code for java.util.Collection.toArray() in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Overrides:
toArray sample code for java.util.AbstractCollection.toArray() definition code for java.util.AbstractCollection.toArray() in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Returns:
an array containing all of the elements in this collection.

toArray sample code for java.util.concurrent.ArrayBlockingQueue.<T>toArray(T[]) definition code for java.util.concurrent.ArrayBlockingQueue.<T>toArray(T[])

public <T> T[] toArray(T[] a)
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.toArray(T[]) definition code for java.util.AbstractCollection.toArray(T[])
Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection 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 collection.

If the collection fits in the specified array with room to spare (i.e., the array has more elements than the collection), the element in the array immediately following the end of the collection is set to null. This is useful in determining the length of the collection only if the caller knows that the collection does not contain any null elements.)

If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

This implementation checks if the array is large enough to contain the collection; if not, it allocates a new array of the correct size and type (using reflection). Then, it iterates over the collection, storing each object reference in the next consecutive element of the array, starting with element 0. If the array is larger than the collection, a null is stored in the first location after the end of the collection.

Specified by:
toArray sample code for java.util.Collection.toArray(T[]) definition code for java.util.Collection.toArray(T[]) in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Overrides:
toArray sample code for java.util.AbstractCollection.toArray(T[]) definition code for java.util.AbstractCollection.toArray(T[]) in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Parameters:
a - the array into which the elements of the collection 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 the elements of the collection.

toString sample code for java.util.concurrent.ArrayBlockingQueue.toString() definition code for java.util.concurrent.ArrayBlockingQueue.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Description copied from class: AbstractCollection sample code for java.util.AbstractCollection.toString() definition code for java.util.AbstractCollection.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).

This implementation creates an empty string buffer, appends a left square bracket, and iterates over the collection appending the string representation of each element in turn. After appending each element except the last, the string ", " is appended. Finally a right bracket is appended. A string is obtained from the string buffer, and returned.

Overrides:
toString sample code for java.util.AbstractCollection.toString() definition code for java.util.AbstractCollection.toString() in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Returns:
a string representation of this collection.

clear sample code for java.util.concurrent.ArrayBlockingQueue.clear() definition code for java.util.concurrent.ArrayBlockingQueue.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 sample code for java.util.Collection.clear() definition code for java.util.Collection.clear() in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Overrides:
clear sample code for java.util.AbstractQueue.clear() definition code for java.util.AbstractQueue.clear() in class AbstractQueue sample code for java.util.AbstractQueue definition code for java.util.AbstractQueue <E>

drainTo sample code for java.util.concurrent.ArrayBlockingQueue.drainTo(java.util.Collection<? super E>) definition code for java.util.concurrent.ArrayBlockingQueue.drainTo(java.util.Collection<? super E>)

public int drainTo(Collection sample code for java.util.Collection definition code for java.util.Collection <? super E> c)
Description copied from interface: BlockingQueue sample code for java.util.concurrent.BlockingQueue.drainTo(java.util.Collection) definition code for java.util.concurrent.BlockingQueue.drainTo(java.util.Collection)
Removes all available elements from this queue and adds them into 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 sample code for java.util.concurrent.BlockingQueue.drainTo(java.util.Collection) definition code for java.util.concurrent.BlockingQueue.drainTo(java.util.Collection) in interface BlockingQueue sample code for java.util.concurrent.BlockingQueue definition code for java.util.concurrent.BlockingQueue <E>
Parameters:
c - the collection to transfer elements into
Returns:
the number of elements transferred.

drainTo sample code for java.util.concurrent.ArrayBlockingQueue.drainTo(java.util.Collection<? super E>, int) definition code for java.util.concurrent.ArrayBlockingQueue.drainTo(java.util.Collection<? super E>, int)

public int drainTo(Collection sample code for java.util.Collection definition code for java.util.Collection <? super E> c,
                   int maxElements)
Description copied from interface: BlockingQueue sample code for java.util.concurrent.BlockingQueue.drainTo(java.util.Collection, int) definition code for java.util.concurrent.BlockingQueue.drainTo(java.util.Collection, int)
Removes at most the given number of available elements from this queue and adds them into 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 sample code for java.util.concurrent.BlockingQueue.drainTo(java.util.Collection, int) definition code for java.util.concurrent.BlockingQueue.drainTo(java.util.Collection, int) in interface BlockingQueue sample code for java.util.concurrent.BlockingQueue definition code for java.util.concurrent.BlockingQueue <E>
Parameters:
c - the collection to transfer elements into
maxElements - the maximum number of elements to transfer
Returns:
the number of elements transferred.

iterator sample code for java.util.concurrent.ArrayBlockingQueue.iterator() definition code for java.util.concurrent.ArrayBlockingQueue.iterator()

public Iterator sample code for java.util.Iterator definition code for java.util.Iterator <E> iterator()
Returns an iterator over the elements in this queue in proper sequence. The returned Iterator is a "weakly consistent" iterator that will never throw ConcurrentModificationException sample code for java.util.ConcurrentModificationException definition code for java.util.ConcurrentModificationException , and guarantees to traverse elements as they existed upon construction of the iterator, and may (but is not guaranteed to) reflect any modifications subsequent to construction.

Specified by:
iterator sample code for java.lang.Iterable.iterator() definition code for java.lang.Iterable.iterator() in interface Iterable sample code for java.lang.Iterable definition code for java.lang.Iterable <E>
Specified by:
iterator sample code for java.util.Collection.iterator() definition code for java.util.Collection.iterator() in interface Collection sample code for java.util.Collection definition code for java.util.Collection <E>
Specified by:
iterator sample code for java.util.AbstractCollection.iterator() definition code for java.util.AbstractCollection.iterator() in class AbstractCollection sample code for java.util.AbstractCollection definition code for java.util.AbstractCollection <E>
Returns:
an iterator over the elements in this queue in proper sequence.