|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.util.AbstractCollection | +--edu.emory.mathcs.util.AbstractQueue | +--edu.emory.mathcs.util.concurrent.DelayQueue
An unbounded blocking queue of Delayed elements, in which an element can only be taken when its delay has expired. The head of the queue is that Delayed element whose delay expired furthest in the past. If no delay has expired there is no head and poll will return null. Expiration occurs when an element's getDelay(TimeUnit.NANOSECONDS) method returns a value less than or equal to zero. This queue does not permit null elements.
This class and its iterator implement all of the
optional methods of the Collection
and Iterator
interfaces.
This class is a member of the Java Collections Framework.
Constructor Summary | |
DelayQueue()
Creates a new DelayQueue that is initially empty. |
|
DelayQueue(java.util.Collection c)
Creates a DelayQueue initially containing the elements of the given collection of Delayed instances. |
Method Summary | |
boolean |
add(java.lang.Object o)
Adds the specified element to this queue. |
void |
clear()
Atomically removes all of the elements from this delay queue. |
int |
drainTo(java.util.Collection c)
Removes all available elements from this queue and adds them into the given collection. |
int |
drainTo(java.util.Collection c,
int maxElements)
Removes at most the given number of available elements from this queue and adds them into the given collection. |
java.util.Iterator |
iterator()
Returns an iterator over the elements in this queue. |
boolean |
offer(java.lang.Object o)
Inserts the specified element into this delay queue. |
boolean |
offer(java.lang.Object o,
long timeout,
TimeUnit unit)
Inserts the specified element into this delay queue. |
java.lang.Object |
peek()
Retrieves, but does not remove, the head of this queue, returning null if this queue has no elements with an unexpired delay. |
java.lang.Object |
poll()
Retrieves and removes the head of this queue, or null if this queue has no elements with an unexpired delay. |
java.lang.Object |
poll(long timeout,
TimeUnit unit)
Retrieves and removes the head of this queue, waiting if necessary up to the specified wait time if no elements with an unexpired delay are present on this queue. |
void |
put(java.lang.Object o)
Adds the specified element to this delay queue. |
int |
remainingCapacity()
Always returns Integer.MAX_VALUE because a DelayQueue is not capacity constrained. |
boolean |
remove(java.lang.Object o)
Removes a single instance of the specified element from this queue, if it is present. |
int |
size()
|
java.lang.Object |
take()
Retrieves and removes the head of this queue, waiting if no elements with an unexpired delay are present on this queue. |
java.lang.Object[] |
toArray()
|
java.lang.Object[] |
toArray(java.lang.Object[] array)
|
Methods inherited from class edu.emory.mathcs.util.AbstractQueue |
addAll, element, remove |
Methods inherited from class java.util.AbstractCollection |
contains, containsAll, isEmpty, removeAll, retainAll, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface edu.emory.mathcs.util.Queue |
element, remove |
Methods inherited from interface java.util.Collection |
addAll, contains, containsAll, equals, hashCode, isEmpty, removeAll, retainAll |
Constructor Detail |
public DelayQueue()
public DelayQueue(java.util.Collection c)
Delayed
instances.
c
- the collection
java.lang.NullPointerException
- if c or any element within it
is nullMethod Detail |
public boolean offer(java.lang.Object o)
offer
in interface BlockingQueue
o
- the element to add
java.lang.NullPointerException
- if the specified element is null.public void put(java.lang.Object o)
put
in interface BlockingQueue
o
- the element to add
java.lang.NullPointerException
- if the specified element is null.public boolean offer(java.lang.Object o, long timeout, TimeUnit unit)
offer
in interface BlockingQueue
o
- the element to addtimeout
- This parameter is ignored as the method never blocksunit
- This parameter is ignored as the method never blocks
java.lang.NullPointerException
- if the specified element is null.public boolean add(java.lang.Object o)
add
in interface BlockingQueue
add
in class AbstractQueue
o
- the element to add
java.lang.NullPointerException
- if the specified element is null.public java.lang.Object take() throws java.lang.InterruptedException
take
in interface BlockingQueue
java.lang.InterruptedException
- if interrupted while waiting.public java.lang.Object poll(long timeout, TimeUnit unit) throws java.lang.InterruptedException
poll
in interface BlockingQueue
timeout
- 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.public java.lang.Object poll()
poll
in interface Queue
public java.lang.Object peek()
peek
in interface Queue
public int size()
size
in interface java.util.Collection
size
in class java.util.AbstractCollection
public int drainTo(java.util.Collection c)
BlockingQueue
drainTo
in interface BlockingQueue
c
- the collection to transfer elements into
public int drainTo(java.util.Collection c, int maxElements)
BlockingQueue
drainTo
in interface BlockingQueue
c
- the collection to transfer elements intomaxElements
- the maximum number of elements to transfer
public void clear()
clear
in interface java.util.Collection
clear
in class AbstractQueue
public int remainingCapacity()
remainingCapacity
in interface BlockingQueue
public java.lang.Object[] toArray()
toArray
in interface java.util.Collection
toArray
in class java.util.AbstractCollection
public java.lang.Object[] toArray(java.lang.Object[] array)
toArray
in interface java.util.Collection
toArray
in class java.util.AbstractCollection
public boolean remove(java.lang.Object o)
remove
in interface java.util.Collection
remove
in class java.util.AbstractCollection
public java.util.Iterator iterator()
ConcurrentModificationException
upon detected interference.
iterator
in interface java.util.Collection
iterator
in class java.util.AbstractCollection
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |