|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractQueue<E>
jsr166y.LinkedTransferQueue<E>
E
- the type of elements held in this collectionpublic 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.
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.
Constructor Summary | |
---|---|
LinkedTransferQueue()
Creates an initially empty LinkedTransferQueue. |
|
LinkedTransferQueue(java.util.Collection<? extends E> c)
Creates a LinkedTransferQueue initially containing the elements of the given collection, added in traversal order of the collection's iterator. |
Method Summary | |
---|---|
int |
drainTo(java.util.Collection<? super E> c)
|
int |
drainTo(java.util.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()
|
java.util.Iterator<E> |
iterator()
|
boolean |
offer(E e)
|
boolean |
offer(E e,
long timeout,
java.util.concurrent.TimeUnit unit)
|
E |
peek()
|
E |
poll()
|
E |
poll(long timeout,
java.util.concurrent.TimeUnit unit)
|
void |
put(E e)
|
int |
remainingCapacity()
|
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,
java.util.concurrent.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. |
Methods inherited from class java.util.AbstractQueue |
---|
add, addAll, clear, element, remove |
Methods inherited from class java.util.AbstractCollection |
---|
contains, containsAll, remove, removeAll, retainAll, toArray, toArray, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.concurrent.BlockingQueue |
---|
add, contains, remove |
Methods inherited from interface java.util.Queue |
---|
element, remove |
Methods inherited from interface java.util.Collection |
---|
addAll, clear, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray |
Constructor Detail |
---|
public LinkedTransferQueue()
public LinkedTransferQueue(java.util.Collection<? extends E> c)
c
- the collection of elements to initially contain
java.lang.NullPointerException
- if the specified collection or any
of its elements are nullMethod Detail |
---|
public void put(E e) throws java.lang.InterruptedException
put
in interface java.util.concurrent.BlockingQueue<E>
java.lang.InterruptedException
public boolean offer(E e, long timeout, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException
offer
in interface java.util.concurrent.BlockingQueue<E>
java.lang.InterruptedException
public boolean offer(E e)
offer
in interface java.util.concurrent.BlockingQueue<E>
offer
in interface java.util.Queue<E>
public void transfer(E e) throws java.lang.InterruptedException
TransferQueue
transfer
in interface TransferQueue<E>
e
- the element to transfer
java.lang.InterruptedException
- if interrupted while waiting,
in which case the element is not enqueued.public boolean tryTransfer(E e, long timeout, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException
TransferQueue
tryTransfer
in interface TransferQueue<E>
e
- the element to transfertimeout
- how long to wait before giving up, in units of
unitunit
- a TimeUnit determining how to interpret the
timeout parameter
java.lang.InterruptedException
- if interrupted while waiting,
in which case the element is not enqueued.public boolean tryTransfer(E e)
TransferQueue
tryTransfer
in interface TransferQueue<E>
e
- the element to transfer
public E take() throws java.lang.InterruptedException
take
in interface java.util.concurrent.BlockingQueue<E>
java.lang.InterruptedException
public E poll(long timeout, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException
poll
in interface java.util.concurrent.BlockingQueue<E>
java.lang.InterruptedException
public E poll()
poll
in interface java.util.Queue<E>
public int drainTo(java.util.Collection<? super E> c)
drainTo
in interface java.util.concurrent.BlockingQueue<E>
public int drainTo(java.util.Collection<? super E> c, int maxElements)
drainTo
in interface java.util.concurrent.BlockingQueue<E>
public java.util.Iterator<E> iterator()
iterator
in interface java.lang.Iterable<E>
iterator
in interface java.util.Collection<E>
iterator
in class java.util.AbstractCollection<E>
public E peek()
peek
in interface java.util.Queue<E>
public boolean isEmpty()
isEmpty
in interface java.util.Collection<E>
isEmpty
in class java.util.AbstractCollection<E>
public boolean hasWaitingConsumer()
TransferQueue
hasWaitingConsumer
in interface TransferQueue<E>
public int size()
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 java.util.Collection<E>
size
in class java.util.AbstractCollection<E>
public int getWaitingConsumerCount()
TransferQueue
getWaitingConsumerCount
in interface TransferQueue<E>
public int remainingCapacity()
remainingCapacity
in interface java.util.concurrent.BlockingQueue<E>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |