| java.util.concurrent.LinkedBlockingQueue
| LinkedBlockingQueue | | public class LinkedBlockingQueue extends AbstractQueue implements BlockingQueue<E>,java.io.Serializable(Code) | | An optionally-bounded
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 implements all of the optional methods
of the
Collection and
Iterator interfaces.
This class is a member of the
Java Collections Framework.
since:
1.5
author:
Doug Lea<
Parameters:
E - > the type of elements held in this collection |
| Inner Class :static class Node | |
| Method Summary | |
| public void | clear()
| | public int | drainTo(Collection<? super E> c)
| | public int | drainTo(Collection<? super E> c, int maxElements)
| | public Iterator<E> | iterator()
Returns an iterator over the elements in this queue in proper sequence. | | public 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. | | public boolean | offer(E o)
Inserts the specified element at the tail of this queue if possible,
returning immediately if this queue is full.
Parameters:
o - the element to add. | | public E | peek()
| | public E | poll(long timeout, TimeUnit unit)
| | public E | poll()
| | public void | put(E o)
Adds the specified element to the tail of this queue, waiting if
necessary for space to become available. | | public int | remainingCapacity()
Returns the number of elements that this queue can ideally (in
the absence of memory or resource constraints) accept without
blocking. | | public boolean | remove(Object o)
| | public int | size()
Returns the number of elements in this queue. | | public E | take()
| | public Object[] | toArray()
| | public T[] | toArray(T[] a)
| | public String | toString()
|
| LinkedBlockingQueue | | public LinkedBlockingQueue()(Code) | | Creates a LinkedBlockingQueue with a capacity of
Integer.MAX_VALUE .
|
| LinkedBlockingQueue | | public LinkedBlockingQueue(int capacity)(Code) | | Creates a LinkedBlockingQueue with the given (fixed) capacity.
Parameters:
capacity - the capacity of this queue.
throws:
IllegalArgumentException - if capacity is not greaterthan zero. |
| LinkedBlockingQueue | | public LinkedBlockingQueue(Collection<? extends E> c)(Code) | | 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.
Parameters:
c - the collection of elements to initially contain
throws:
NullPointerException - if c or any element within itis null |
| clear | | public void clear()(Code) | | |
| iterator | | public Iterator<E> iterator()(Code) | | Returns an iterator over the elements in this queue in proper sequence.
The returned Iterator is a "weakly consistent" iterator that
will never throw
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.
an iterator over the elements in this queue in proper sequence. |
| offer | | public boolean offer(E o, long timeout, TimeUnit unit) throws InterruptedException(Code) | | Inserts the specified element at the tail of this queue, waiting if
necessary up to the specified wait time for space to become available.
Parameters:
o - the element to add
Parameters:
timeout - how long to wait before giving up, in units ofunit
Parameters:
unit - a TimeUnit determining how to interpret thetimeout parameter true if successful, or false ifthe specified waiting time elapses before space is available.
throws:
InterruptedException - if interrupted while waiting.
throws:
NullPointerException - if the specified element is null. |
| offer | | public boolean offer(E o)(Code) | | Inserts the specified element at the tail of this queue if possible,
returning immediately if this queue is full.
Parameters:
o - the element to add. true if it was possible to add the element tothis queue, else false
throws:
NullPointerException - if the specified element is null |
| remainingCapacity | | public int remainingCapacity()(Code) | | 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.
|
| size | | public int size()(Code) | | Returns the number of elements in this queue.
the number of elements in this queue. |
| toArray | | public T[] toArray(T[] a)(Code) | | |
|
|