E
- the type of elements held in this collectionpublic class LegacyLinkedTransferQueue<E> extends AbstractQueue<E> implements BlockingQueue<E>, Serializable
QueueFactory
to create a Queue as it will use the "optimal" implementation depending on the JVM
BlockingQueue
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 and Description |
---|
LegacyLinkedTransferQueue()
Creates an initially empty
LinkedTransferQueue . |
LegacyLinkedTransferQueue(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)
Inserts the specified element at the tail of this queue.
|
int |
drainTo(Collection<? super E> c) |
int |
drainTo(Collection<? super E> c,
int maxElements) |
int |
getWaitingConsumerCount() |
boolean |
hasWaitingConsumer() |
boolean |
isEmpty()
Returns
true if this queue contains no elements. |
Iterator<E> |
iterator()
Returns an iterator over the elements in this queue in proper
sequence, from head to tail.
|
boolean |
offer(E e)
Inserts the specified element at the tail of this queue.
|
boolean |
offer(E e,
long timeout,
TimeUnit unit)
Inserts the specified element at the tail of this queue.
|
E |
peek() |
E |
poll() |
E |
poll(long timeout,
TimeUnit unit) |
void |
put(E e)
Inserts the specified element at the tail of this queue.
|
int |
remainingCapacity()
Always returns
Integer.MAX_VALUE because a
LinkedTransferQueue is not capacity constrained. |
boolean |
remove(Object o)
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() |
void |
transfer(E e)
Transfers the element to a consumer, waiting if necessary to do so.
|
boolean |
tryTransfer(E e)
Transfers the element to a waiting consumer immediately, if possible.
|
boolean |
tryTransfer(E e,
long timeout,
TimeUnit unit)
Transfers the element to a consumer if it is possible to do so
before the timeout elapses.
|
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 LegacyLinkedTransferQueue()
LinkedTransferQueue
.public LegacyLinkedTransferQueue(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)
put
in interface BlockingQueue<E>
NullPointerException
- if the specified element is nullpublic boolean offer(E e, long timeout, TimeUnit unit)
false
.offer
in interface BlockingQueue<E>
true
(as specified by
BlockingQueue.offer
)NullPointerException
- if the specified element is nullpublic boolean offer(E e)
false
.offer
in interface BlockingQueue<E>
offer
in interface Queue<E>
true
(as specified by
BlockingQueue.offer
)NullPointerException
- if the specified element is nullpublic boolean add(E e)
IllegalStateException
or return false
.add
in interface Collection<E>
add
in interface BlockingQueue<E>
add
in interface Queue<E>
add
in class AbstractQueue<E>
true
(as specified by Collection.add(E)
)NullPointerException
- if the specified element is nullpublic boolean tryTransfer(E e)
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.
NullPointerException
- if the specified element is nullpublic void transfer(E e) throws InterruptedException
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.
NullPointerException
- if the specified element is nullInterruptedException
public boolean tryTransfer(E e, long timeout, TimeUnit unit) throws InterruptedException
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.
NullPointerException
- if the specified element is nullInterruptedException
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>
NullPointerException
IllegalArgumentException
public int drainTo(Collection<? super E> c, int maxElements)
drainTo
in interface BlockingQueue<E>
NullPointerException
IllegalArgumentException
public Iterator<E> iterator()
The returned iterator is a "weakly consistent" iterator that
will never throw
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.
iterator
in interface Iterable<E>
iterator
in interface Collection<E>
iterator
in class AbstractCollection<E>
public boolean isEmpty()
true
if this queue contains no elements.isEmpty
in interface Collection<E>
isEmpty
in class AbstractCollection<E>
true
if this queue contains no elementspublic boolean hasWaitingConsumer()
public 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()
public boolean remove(Object o)
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).remove
in interface Collection<E>
remove
in interface BlockingQueue<E>
remove
in class AbstractCollection<E>
o
- element to be removed from this queue, if presenttrue
if this queue changed as a result of the callpublic int remainingCapacity()
Integer.MAX_VALUE
because a
LinkedTransferQueue
is not capacity constrained.remainingCapacity
in interface BlockingQueue<E>
Integer.MAX_VALUE
(as specified by
BlockingQueue.remainingCapacity()
)Copyright © 2008-2012 The Netty Project. All Rights Reserved.