Class ReferenceQueue<T>

java.lang.Object

java.lang.ref.ReferenceQueue<T>

public class ReferenceQueue<T>
extends Object

ReferenceQueue is the container on which reference objects are enqueued when their reachability type is detected for the referent.

Since:

1.2

Constructor Summary

Constructors

Constructor	Description
ReferenceQueue()	Constructs a new instance of this class.

Method Summary

Modifier and Type	Method	Description
Reference<? extends T>	poll()	Returns the next available reference from the queue if one is enqueued, null otherwise.
Reference<? extends T>	remove()	Return the next available enqueued reference on the queue, blocking indefinitely until one is available.
Reference<? extends T>	remove(long timeout)	Return the next available enqueued reference on the queue, blocking up to the time given until one is available.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Constructor Details

ReferenceQueue

public ReferenceQueue()

Constructs a new instance of this class.

Method Details

poll

public Reference<? extends T> poll()

Returns the next available reference from the queue if one is enqueued, null otherwise. Does not wait for a reference to become available.

Returns:

Reference next available Reference or NULL.

remove

public Reference<? extends T> remove()
                              throws InterruptedException

Return the next available enqueued reference on the queue, blocking indefinitely until one is available.

Returns:

Reference a Reference object if one is available, null otherwise.

Throws:

InterruptedException - to interrupt the wait.

remove

public Reference<? extends T> remove(long timeout)
                              throws IllegalArgumentException,
InterruptedException

Return the next available enqueued reference on the queue, blocking up to the time given until one is available. Return null if no reference became available.

Parameters:

timeout - maximum time spent waiting for a reference object to become available.

Returns:

Reference a Reference object if one is available, null otherwise.

Throws:

IllegalArgumentException - if the wait period is negative.

InterruptedException - to interrupt the wait.