|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object![]()
![]()
![]()
java.util.AbstractCollection
![]()
![]()
<E>
java.util.AbstractQueue
![]()
![]()
<E>
java.util.concurrent.LinkedBlockingQueue<E>
E - the type of elements held in this collection
, Iterable
<E>, Collection
<E>, BlockingQueue
<E>, Queue
<E>public class LinkedBlockingQueue<E>
<E>
<E>, Serializable

An optionally-bounded blocking queue
based on
linked nodes.
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.
Linked queues typically have higher throughput than array-based queues but
less predictable performance in most concurrent applications.
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.
| Constructor Summary | |
|---|---|
LinkedBlockingQueue
Creates a LinkedBlockingQueue with a capacity of Integer.MAX_VALUE . |
|
LinkedBlockingQueue
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. |
|
LinkedBlockingQueue
Creates a LinkedBlockingQueue with the given (fixed) capacity. |
|
| Method Summary | ||
|---|---|---|
void |
clear
Atomically removes all of the elements from this queue. |
|
int |
drainTo
Removes all available elements from this queue and adds them into the given collection. |
|
int |
drainTo
Removes at most the given number of available elements from this queue and adds them into the given collection. |
|
Iterator |
iterator
Returns an iterator over the elements in this queue in proper sequence. |
|
boolean |
offer
Inserts the specified element at the tail of this queue if possible, returning immediately if this queue is full. |
|
boolean |
offer
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
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
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
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
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 |
Methods inherited from class java.util.AbstractCollection ![]() |
|---|
contains |
Methods inherited from class java.lang.Object ![]() |
|---|
clone |
Methods inherited from interface java.util.concurrent.BlockingQueue ![]() |
|---|
add |
Methods inherited from interface java.util.Queue ![]() |
|---|
element |
Methods inherited from interface java.util.Collection ![]() |
|---|
addAll |
| Constructor Detail |
|---|

public LinkedBlockingQueue()
Integer.MAX_VALUE
.

public LinkedBlockingQueue(int capacity)
capacity - the capacity of this queue.
IllegalArgumentException

- if capacity is not greater
than zero.

public LinkedBlockingQueue(Collection![]()
![]()
<? extends E> c)
Integer.MAX_VALUE
, initially containing the elements of the
given collection,
added in traversal order of the collection's iterator.
c - the collection of elements to initially contain
NullPointerException

- if c or any element within it
is null| Method Detail |
|---|

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 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 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 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 E take()
throws InterruptedException

BlockingQueue

take

in interface BlockingQueue
<E>InterruptedException

- if interrupted while waiting.

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 E poll()
Queue

poll

in interface Queue
<E>

public E peek()
Queue

peek

in interface Queue
<E>

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 Object![]()
![]()
[] toArray()
AbstractCollection

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.
toArray

in interface Collection
<E>toArray

in class AbstractCollection
<E>

public <T> T[] toArray(T[] a)
AbstractCollection

If the collection fits in the specified array with room to spare (i.e., the array has more e