ej.bon

Class ReferenceQueue

java.lang.Object

ej.bon.ReferenceQueue

public final class ReferenceQueue
extends java.lang.Object

ReferenceQueue represents a queue of EnqueuedWeakReference. The system is responsible for adding such EnqueuedWeakReference into the ReferenceQueue.
There are two ways to retrieve and remove an element from the queue.
- poll() : returns null if the queue is empty, otherwise returns and removes the first element of the FIFO queue.
- remove() : blocks the current thread until the queue becomes not empty. returns and removes the first element of the FIFO queue.

See Also:

EnqueuedWeakReference

Constructor Summary

Constructors

Constructor and Description
ReferenceQueue()

Method Summary

Modifier and Type	Method and Description
EnqueuedWeakReference	poll() Queries the queue and returns and removes the first element of the queue.
EnqueuedWeakReference	remove() Queries the queue, returns and removes the first element of the queue.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReferenceQueue

public ReferenceQueue()

Method Detail

poll

public EnqueuedWeakReference poll()

Queries the queue and returns and removes the first element of the queue. If the queue is empty, returns null.

Returns:

EnqueuedWeakReference or null

remove

public EnqueuedWeakReference remove()
                             throws java.lang.InterruptedException

Queries the queue, returns and removes the first element of the queue. If the queue is empty, blocks the current thread until the queue gets at least one element (automatically added by the system).

Returns:

EnqueuedWeakReference

Throws:

java.lang.InterruptedException - if the thread is interrupted