java.util.AbstractCollection<E>
java.util.AbstractQueue<E>
java.util.concurrent.ArrayBlockingQueue<E>
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
E - the type of elements held in this collectionpublic class ArrayBlockingQueue<E>
A bounded blocking queue 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 and Iterator interfaces.
This class is a member of the Java Collections Framework.
| Constructor Summary | |
|---|---|
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 | ||
|---|---|---|
void |
clear()
Atomically removes all of the elements from this queue. |
|
boolean |
contains(Object o)
Returns true if this collection contains the specified element. |
|
int |
drainTo(Collection<? super E> c)
Removes all available elements from this queue and adds them into 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 into the given collection. |
|
Iterator<E> |
iterator()
Returns an iterator over the elements in this queue in proper sequence. |
|
boolean |
offer(E o)
Inserts the specified element at the tail of this queue if possible, returning immediately if this queue is full. |
|
boolean |
offer(E o,
long timeout,
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()
Retrieves, but does not remove, the head of this queue, returning null if this queue is empty. |
|
E |
poll()
Retrieves and removes the head of this queue, or null if this queue is empty. |
|
E |
poll(long timeout,
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(E o)
Adds the specified element to the tail of this queue, waiting if necessary for space to become available. |
|
int |
remainingCapacity()
Returns the number of 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. |
|
int |
size()
Returns the number of elements in this queue. |
|
E |
take()
Retrieves and removes the head of this queue, waiting if no elements are present on this queue. |
|
Object[] |
toArray()
Returns an array containing all of the elements in this collection. |
|
|
toArray(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 |
toString()
Returns a string representation of this collection. |
|
| Methods inherited from class java.util.AbstractQueue |
|---|
add, addAll, element, remove |
| Methods inherited from class java.util.AbstractCollection |
|---|
containsAll, isEmpty, removeAll, retainAll |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface java.util.concurrent.BlockingQueue |
|---|
add |
| Methods inherited from interface java.util.Queue |
|---|
element, remove |
| Methods inherited from interface java.util.Collection |
|---|
addAll, containsAll, equals, hashCode, isEmpty, removeAll, retainAll |
| Constructor Detail |
|---|
public ArrayBlockingQueue(int capacity)
capacity - the capacity of this queue
IllegalArgumentException - if capacity is less than 1
public ArrayBlockingQueue(int capacity,
boolean fair)
capacity - the capacity of this queuefair - if true then queue accesses for threads blocked
on insertion or removal, are processed in FIFO order; if false
the access order is unspecified.
IllegalArgumentException - if capacity is less than 1
public ArrayBlockingQueue(int capacity,
boolean fair,
Collection<? extends E> c)
capacity - the capacity of this queuefair - 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
IllegalArgumentException - if capacity is less than
c.size(), or less than 1.
NullPointerException - if c or any element within it
is null| Method Detail |
|---|
public boolean offer(E o)
offer in interface BlockingQueue<E>offer in interface Queue<E>o - the element to add.
NullPointerException - if the specified element is null
public boolean offer(E o,
long timeout,
TimeUnit unit)
throws InterruptedException
offer in interface BlockingQueue<E>o - the element to addtimeout - how long to wait before giving up, in units of
unitunit - a TimeUnit determining how to interpret the
timeout parameter
InterruptedException - if interrupted while waiting.
NullPointerException - if the specified element is null.public E poll()
Queue
poll in interface Queue<E>
public E poll(long timeout,
TimeUnit unit)
throws InterruptedException
BlockingQueue
poll in interface BlockingQueue<E>timeout - how long to wait before giving up, in units of
unitunit - a TimeUnit determining how to interpret the
timeout parameter
InterruptedException - if interrupted while waiting.public boolean remove(Object o)
remove in interface Collection<E>remove in class AbstractCollection<E>o - element to be removed from this collection, if present.
public E peek()
Queue
peek in interface Queue<E>
public E take()
throws InterruptedException
BlockingQueue
take in interface BlockingQueue<E>InterruptedException - if interrupted while waiting.
public void put(E o)
throws InterruptedException
put in interface BlockingQueue<E>o - the element to add
InterruptedException - if interrupted while waiting.
NullPointerException - if the specified element is null.public int size()
size in interface Collection<E>size in class AbstractCollection<E>public int remainingCapacity()
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.
remainingCapacity in interface BlockingQueue<E>public boolean contains(Object o)
AbstractCollectionThis implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element.
contains in interface Collection<E>contains in class AbstractCollection<E>o - object to be checked for containment in this collection.
public Object[] toArray()
AbstractCollectionThis 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.
toArray in interface Collection<E>toArray in class AbstractCollection<E>public <T> T[] toArray(T[] a)
AbstractCollectionIf 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.
toArray in interface Collection<E>toArray in class AbstractCollection<E>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.
public String toString()
AbstractCollectionThis 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.
toString in class AbstractCollection<E>public void clear()
clear in interface Collection<E>clear in class AbstractQueue<E>public int drainTo(Collection<? super E> c)
BlockingQueue
drainTo in interface BlockingQueue<E>c - the collection to transfer elements into
public int drainTo(Collection<? super E> c,
int maxElements)
BlockingQueue
drainTo in interface BlockingQueue<E>c - the collection to transfer elements intomaxElements - the maximum number of elements to transfer
public Iterator<E> iterator()
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.
iterator in interface Iterable<E>iterator in interface Collection<E>iterator in class AbstractCollection<E>
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.