LinkedBlockingQueue<E>
Java SE 6
| public class java.util.concurrent LinkedBlockingQueue<E>
|
Java SE 6 |
The optional capacity bound constructor argument serves as a
way to prevent excessive queue expansion. The capacity, if unspecified,
is equal to Integer#MAX_VALUE. Linked nodes are
dynamically created upon each insertion unless this would bring the
queue above capacity.
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.
| since | 1.5 |
| E | the type of elements held in this collection |
| Constructors | |||||
|---|---|---|---|---|---|
| public | LinkedBlockingQueue() Creates a LinkedBlockingQueue with a capacity of Integer#MAX_VALUE.
| ||||
| public | LinkedBlockingQueue(int capacity) Details
Creates a LinkedBlockingQueue with the given (fixed) capacity.
| ||||
| public | LinkedBlockingQueue(Collection c) Details
Creates a LinkedBlockingQueue with a capacity of
Integer#MAX_VALUE, initially containing the elements of the
given collection,
added in traversal order of the collection's iterator.
| ||||
| Methods | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| public void | clear() Atomically removes all of the elements from this queue. The queue will be empty after this call returns. | ||||||||
| public int | drainTo(Collection c) Details
| ||||||||
| public int | drainTo(Collection c, int maxElements) Details
| ||||||||
| public Iterator | iterator() Details
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,
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.
| ||||||||
| public boolean | offer(Object e, long timeout, TimeUnit unit) throws InterruptedException Details
Inserts the specified element at the tail of this queue, waiting if
necessary up to the specified wait time for space to become available.
| ||||||||
| public boolean | offer(Object e) Details
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.
When using a capacity-restricted queue, this method is generally
preferable to method add, which can fail to
insert an element only by throwing an exception.
| ||||||||
| public Object | peek() | ||||||||
| public Object | poll(long timeout, TimeUnit unit) throws InterruptedException | ||||||||
| public Object | poll() | ||||||||
| public void | put(Object e) throws InterruptedException Details
Inserts the specified element at the tail of this queue, waiting if
necessary for space to become available.
| ||||||||
| 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. | ||||||||
| public boolean | remove(Object o) Details
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).
| ||||||||
| public int | size() Details
Returns the number of elements in this queue.
| ||||||||
| public Object | take() throws InterruptedException | ||||||||
| public Object[] | toArray() Details
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.
| ||||||||
| public Object[]<T> | toArray(Object[] a) Details
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 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().
| ||||||||
| public String | toString() | ||||||||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2009 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
 |
 |
|