E
- the type of elements held in this collectionpublic class LinkedTransferQueue<E> extends AbstractQueue<E> implements TransferQueue<E>, Serializable
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.
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.
version 1.17 Tue Mar 31 15:17:19 2009 UTC ( gustav trede copied from jsr166 CVS )
Constructor and Description |
---|
LinkedTransferQueue()
Creates an initially empty
LinkedTransferQueue . |
LinkedTransferQueue(Collection<? extends E> c)
Creates a
LinkedTransferQueue
initially containing the elements of the given collection,
added in traversal order of the collection's iterator. |
Modifier and Type | Method and Description |
---|---|
boolean |
add(E e) |
int |
drainTo(Collection<? super E> c) |
int |
drainTo(Collection<? super E> c,
int maxElements) |
int |
getWaitingConsumerCount()
Returns an estimate of the number of consumers waiting to
dequeue elements via
take or poll . |
boolean |
hasWaitingConsumer()
Returns
true if there is at least one consumer waiting
to dequeue an element via take or poll . |
boolean |
isEmpty() |
Iterator<E> |
iterator() |
boolean |
offer(E e) |
boolean |
offer(E e,
long timeout,
TimeUnit unit) |
E |
peek() |
E |
poll() |
E |
poll(long timeout,
TimeUnit unit) |
void |
put(E e) |
int |
remainingCapacity() |
boolean |
remove(Object o) |
int |
size()
Returns the number of elements in this queue.
|
E |
take() |
void |
transfer(E e)
Inserts the specified element into this queue, waiting if
necessary for space to become available and the element to be
dequeued by a consumer invoking
take or poll . |
boolean |
tryTransfer(E e)
Transfers the specified element if there exists a consumer
already waiting to receive it, otherwise returning
false
without enqueuing the element. |
boolean |
tryTransfer(E e,
long timeout,
TimeUnit unit)
Inserts the specified element into this queue, waiting up to
the specified wait time if necessary for space to become
available and the element to be dequeued by a consumer invoking
take or poll . |
addAll, clear, element, remove
contains, containsAll, removeAll, retainAll, toArray, toArray, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
contains
addAll, clear, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray
public LinkedTransferQueue()
LinkedTransferQueue
.public LinkedTransferQueue(Collection<? extends E> c)
LinkedTransferQueue
initially containing the elements of the given collection,
added in traversal order of the collection's iterator.c
- the collection of elements to initially containNullPointerException
- if the specified collection or any
of its elements are nullpublic void put(E e) throws InterruptedException
put
in interface BlockingQueue<E>
InterruptedException
public boolean offer(E e, long timeout, TimeUnit unit) throws InterruptedException
offer
in interface BlockingQueue<E>
InterruptedException
public boolean offer(E e)
public boolean add(E e)
add
in interface Collection<E>
add
in interface BlockingQueue<E>
add
in interface Queue<E>
add
in class AbstractQueue<E>
public void transfer(E e) throws InterruptedException
TransferQueue
take
or poll
.transfer
in interface TransferQueue<E>
e
- the element to transferInterruptedException
- if interrupted while waiting,
in which case the element is not enqueued.public boolean tryTransfer(E e, long timeout, TimeUnit unit) throws InterruptedException
TransferQueue
take
or poll
.tryTransfer
in interface TransferQueue<E>
e
- the element to transfertimeout
- how long to wait before giving up, in units of
unit
unit
- a TimeUnit
determining how to interpret the
timeout
parametertrue
if successful, or false
if
the specified waiting time elapses before completion,
in which case the element is not enqueued.InterruptedException
- if interrupted while waiting,
in which case the element is not enqueued.public boolean tryTransfer(E e)
TransferQueue
false
without enqueuing the element.tryTransfer
in interface TransferQueue<E>
e
- the element to transfertrue
if the element was transferred, else
false
public E take() throws InterruptedException
take
in interface BlockingQueue<E>
InterruptedException
public E poll(long timeout, TimeUnit unit) throws InterruptedException
poll
in interface BlockingQueue<E>
InterruptedException
public int drainTo(Collection<? super E> c)
drainTo
in interface BlockingQueue<E>
public int drainTo(Collection<? super E> c, int maxElements)
drainTo
in interface BlockingQueue<E>
public Iterator<E> iterator()
iterator
in interface Iterable<E>
iterator
in interface Collection<E>
iterator
in class AbstractCollection<E>
public boolean isEmpty()
isEmpty
in interface Collection<E>
isEmpty
in class AbstractCollection<E>
public boolean hasWaitingConsumer()
TransferQueue
true
if there is at least one consumer waiting
to dequeue an element via take
or poll
.
The return value represents a momentary state of affairs.hasWaitingConsumer
in interface TransferQueue<E>
true
if there is at least one waiting consumerpublic int size()
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.
size
in interface Collection<E>
size
in class AbstractCollection<E>
public int getWaitingConsumerCount()
TransferQueue
take
or 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()
.getWaitingConsumerCount
in interface TransferQueue<E>
public int remainingCapacity()
remainingCapacity
in interface BlockingQueue<E>
public boolean remove(Object o)
remove
in interface Collection<E>
remove
in interface BlockingQueue<E>
remove
in class AbstractCollection<E>
Copyright © 2013 Oracle Corporation. All Rights Reserved.