|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class LinkedTransferQueue<E>
java.util.concurrent.LinkedTransferQueue<E>
Type Parameters:
E - the type of elements held in this queue
All Implemented Interfaces:
public class LinkedTransferQueue<E>
An unbounded
TransferQueue based on linked nodes.
This queue orders elements FIFO (first-in-first-out) with respect
to any given producer. The
head of the queue is that
element that has been on the queue the longest time for some
producer. The
tail of the queue is that element that has
been on the queue the shortest time for some producer.
Beware that, unlike in most collections, the size method
is NOT a constant-time operation. Because of the
asynchronous nature of these queues, determining the current number
of elements requires a traversal of the elements, and so may report
inaccurate results if this collection is modified during traversal.
Bulk operations that add, remove, or examine multiple elements,
such as AbstractQueue.addAll(Collection), removeIf(Predicate) or forEach(Consumer),
are not guaranteed to be performed atomically.
For example, a forEach traversal concurrent with an
addAll operation might observe only some of the added elements.
This class and its iterator implement all of the optional
methods of the Collection and Iterator interfaces.
Memory consistency effects: As with other concurrent
collections, actions in a thread prior to placing an object into a
LinkedTransferQueue
happen-before
actions subsequent to the access or removal of that element from
the LinkedTransferQueue in another thread.
This class is a member of the
Java Collections Framework.
Since:
1.7
Author:
Doug Lea
See Also:
Constructor Summary |
Creates an initially empty LinkedTransferQueue.
|
Creates a LinkedTransferQueue
initially containing the elements of the given collection,
added in traversal order of the collection's iterator.
|
Method Summary |
boolean |
Inserts the specified element at the tail of this queue.
|
void |
Removes all of the elements from this queue.
|
boolean |
Returns true if this queue contains the specified element.
|
int |
Removes all available elements from this queue and adds them
to the given collection.
|
int |
Removes at most the given number of available elements from
this queue and adds them to the given collection.
|
void |
Performs the given action for each element of the Iterable
until all elements have been processed or the action throws an
exception.
|
int |
|
boolean |
|
boolean |
Returns true if this queue contains no elements.
|
|
Returns an iterator over the elements in this queue in proper sequence.
|
boolean |
Inserts the specified element at the tail of this queue.
|
boolean |
Inserts the specified element at the tail of this queue.
|
|
Retrieves, but does not remove, the head of this queue,
or returns null if this queue is empty.
|
|
Retrieves and removes the head of this queue,
or returns null if this queue is empty.
|
|
Retrieves and removes the head of this queue, waiting up to the
specified wait time if necessary for an element to become available.
|
void |
Inserts the specified element at the tail of this queue.
|
int |
Always returns Integer.MAX_VALUE because a
LinkedTransferQueue is not capacity constrained.
|
boolean |
Removes a single instance of the specified element from this queue,
if it is present.
|
boolean |
Removes all of this collection's elements that are also contained in the
specified collection (optional operation).
|
boolean |
Removes all of the elements of this collection that satisfy the given
predicate.
|
boolean |
Retains only the elements in this collection that are contained in the
specified collection (optional operation).
|
int |
Returns the number of elements in this queue.
|
|
|
|
Retrieves and removes the head of this queue, waiting if necessary
until an element becomes available.
|
|
Returns an array containing all of the elements in this queue, in
proper sequence.
|
|
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.
|
|
Returns a string representation of this collection.
|
void |
Transfers the element to a consumer, waiting if necessary to do so.
|
boolean |
Transfers the element to a waiting consumer immediately, if possible.
|
boolean |
Transfers the element to a consumer if it is possible to do so
before the timeout elapses.
|
Methods inherited from class java.lang. Object |
|
Methods inherited from interface java.util. Collection |
|
public LinkedTransferQueue |
() |
Creates an initially empty LinkedTransferQueue.
public LinkedTransferQueue |
|
Creates a
LinkedTransferQueue
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:
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).
Overrides:
Returns:
a string representation of this collection
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.
Specified by:
Overrides:
Returns:
an array containing all of the elements in this queue
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 toArray() method, this method acts as bridge between
array-based and collection-based APIs. Further, this method allows
precise control over the runtime type of the output array, and may,
under certain circumstances, be used to save allocation costs.
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().
Specified by:
Overrides:
Type Parameters:
T - the component type of the array to contain the collection
Parameters:
a - the array into which the elements of the queue 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 all of the elements in this queue
Throws:
ArrayStoreException - if the runtime type of the specified array
is not a supertype of the runtime type of every element in
this queue
Inserts the specified element at the tail of this queue.
As the queue is unbounded, this method will never block.
Specified by:
Parameters:
e - the element to add
Throws:
Inserts the specified element at the tail of this queue.
As the queue is unbounded, this method will never block or
return
false.
Specified by:
Parameters:
e - 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:
Throws:
Inserts the specified element at the tail of this queue.
As the queue is unbounded, this method will never return
false.
Specified by:
Parameters:
e - the element to add
Returns:
Throws:
Inserts the specified element at the tail of this queue.
As the queue is unbounded, this method will never throw
IllegalStateException or return
false.
Specified by:
Overrides:
Parameters:
e - the element to add
Returns:
Throws:
public boolean tryTransfer |
|
Transfers the element to a waiting consumer immediately, if possible.
More precisely, transfers the specified element immediately
if there exists a consumer already waiting to receive it (in
take() or timed poll),
otherwise returning false without enqueuing the element.
Specified by:
Parameters:
e - the element to transfer
Returns:
true if the element was transferred, else
false
Throws:
public void transfer |
|
throws |
|
Transfers the element to a consumer, waiting if necessary to do so.
More precisely, transfers the specified element immediately
if there exists a consumer already waiting to receive it (in
take() or timed poll),
else inserts the specified element at the tail of this queue
and waits until the element is received by a consumer.
Specified by:
Parameters:
e - the element to transfer
Throws:
public boolean tryTransfer |
|
throws |
|
Transfers the element to a consumer if it is possible to do so
before the timeout elapses.
More precisely, transfers the specified element immediately
if there exists a consumer already waiting to receive it (in
take() or timed poll),
else inserts the specified element at the tail of this queue
and waits until the element is received by a consumer,
returning false if the specified wait time elapses
before the element can be transferred.
Specified by:
Parameters:
e - the element to transfer
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 completion,
in which case the element is not left enqueued
Throws:
Retrieves and removes the head of this queue, waiting if necessary
until an element becomes available.
Specified by:
Returns:
the head of this queue
Throws:
Retrieves and removes the head of this queue, waiting up to the
specified wait time if necessary for an element to become available.
Specified by:
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 available
Throws:
Description copied from interface:
Queue
Retrieves and removes the head of this queue,
or returns null if this queue is empty.
Specified by:
Returns:
the head of this queue, or null if this queue is empty
Removes all available elements from this queue and adds them
to 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:
Parameters:
c - the collection to transfer elements into
Returns:
the number of elements transferred
Throws:
NullPointerException - if the specified collection is null
IllegalArgumentException - if the specified collection is this
queue, or some property of an element of this queue prevents
it from being added to the specified collection
Removes at most the given number of available elements from
this queue and adds them to 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:
Parameters:
c - the collection to transfer elements into
maxElements - the maximum number of elements to transfer
Returns:
the number of elements transferred
Throws:
NullPointerException - if the specified collection is null
IllegalArgumentException - if the specified collection is this
queue, or some property of an element of this queue prevents
it from being added to the specified collection
Returns an iterator over the elements in this queue in proper sequence.
The elements will be returned in order from first (head) to last (tail).
The returned iterator is
weakly consistent.
Specified by:
Overrides:
Returns:
an iterator over the elements in this queue in proper sequence
Description copied from interface:
Queue
Retrieves, but does not remove, the head of this queue,
or returns null if this queue is empty.
Specified by:
Returns:
the head of this queue, or null if this queue is empty
public boolean isEmpty |
() |
Returns
true if this queue contains no elements.
Specified by:
Overrides:
Returns:
true if this queue contains no elements
public boolean hasWaitingConsumer |
() |
Returns
true if there is at least one consumer waiting
to receive an element via
BlockingQueue.take() or
timed
poll.
The return value represents a momentary state of affairs.
Specified by:
Returns:
true if there is at least one waiting consumer
Returns the number of elements in this queue. If this queue
contains more than
Integer.MAX_VALUE elements, returns
Integer.MAX_VALUE.
Beware that, unlike in most collections, this method is
NOT a constant-time operation. Because of the
asynchronous nature of these queues, determining the current
number of elements requires an O(n) traversal.
Specified by:
Overrides:
Returns:
the number of elements in this queue
public int getWaitingConsumerCount |
() |
Returns an estimate of the number of consumers waiting to
receive elements via
BlockingQueue.take() or timed
poll. The return value is an
approximation of a momentary state of affairs, that may be
inaccurate if consumers have completed or given up waiting.
The value may be useful for monitoring and heuristics, but
not for synchronization control. Implementations of this
method are likely to be noticeably slower than those for
TransferQueue.hasWaitingConsumer().
Specified by:
Returns:
the number of consumers waiting to receive elements
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).
Specified by:
Overrides:
Parameters:
o - element to be removed from this queue, if present
Returns:
true if this queue changed as a result of the call
Returns
true if this queue contains the specified element.
More formally, returns
true if and only if this queue contains
at least one element
e such that
o.equals(e).
Specified by:
Overrides:
Parameters:
o - object to be checked for containment in this queue
Returns:
true if this queue contains the specified element
public int remainingCapacity |
() |
Always returns
Integer.MAX_VALUE because a
LinkedTransferQueue is not capacity constrained.
Specified by:
Returns:
Removes all of the elements of this collection that satisfy the given
predicate. Errors or runtime exceptions thrown during iteration or by
the predicate are relayed to the caller.
Specified by:
Parameters:
filter - a predicate which returns true for elements to be
removed
Returns:
true if any elements were removed
Throws:
Removes all of this collection's elements that are also contained in the
specified collection (optional operation). After this call returns,
this collection will contain no elements in common with the specified
collection.
Specified by:
Overrides:
Parameters:
c - collection containing elements to be removed from this collection
Returns:
true if this collection changed as a result of the
call
Throws:
NullPointerException - if this collection contains one or more
null elements and the specified collection does not support
null elements
(
optional),
or if the specified collection is null
See Also:
Retains only the elements in this collection that are contained in the
specified collection (optional operation). In other words, removes from
this collection all of its elements that are not contained in the
specified collection.
Specified by:
Overrides:
Parameters:
c - collection containing elements to be retained in this collection
Returns:
true if this collection changed as a result of the call
Throws:
NullPointerException - if this collection contains one or more
null elements and the specified collection does not permit null
elements
(
optional),
or if the specified collection is null
See Also:
Removes all of the elements from this queue.
The queue will be empty after this call returns.
This implementation repeatedly invokes poll until it
returns null.
Specified by:
Overrides:
Description copied from interface:
Iterable
Performs the given action for each element of the
Iterable
until all elements have been processed or the action throws an
exception. Actions are performed in the order of iteration, if that
order is specified. Exceptions thrown by the action are relayed to the
caller.
The behavior of this method is unspecified if the action performs
side-effects that modify the underlying source of elements, unless an
overriding class has specified a concurrent modification policy.
Specified by:
Parameters:
action - The action to be performed for each element
Throws:
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz