Class Overview
The ReferenceQueue is the container on which reference objects are
enqueued when the garbage collector detects the reachability type specified
for the referent.
Summary
| Public Constructors |
|---|
|
|
ReferenceQueue()
Constructs a new instance of this class.
|
| Public Methods |
|---|
|
synchronized
Reference<? extends T>
|
poll()
Returns the next available reference from the queue, removing it in the
process.
|
|
Reference<? extends T>
|
remove()
Returns the next available reference from the queue, removing it in the
process.
|
|
synchronized
Reference<? extends T>
|
remove(long timeoutMillis)
Returns the next available reference from the queue, removing it in the
process.
|
|
[Expand]
Inherited Methods |
|---|
From class
java.lang.Object
|
Object
|
clone()
Creates and returns a copy of this Object.
|
|
boolean
|
equals(Object o)
Compares this instance with the specified object and indicates if they
are equal.
|
|
void
|
finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
|
|
final
Class<?>
|
getClass()
Returns the unique instance of Class that represents this
object's class. |
|
int
|
hashCode()
Returns an integer hash code for this object.
|
|
final
void
|
notify()
Causes a thread which is waiting on this object's monitor (by means of
calling one of the wait() methods) to be woken up.
|
|
final
void
|
notifyAll()
Causes all threads which are waiting on this object's monitor (by means
of calling one of the wait() methods) to be woken up.
|
|
String
|
toString()
Returns a string containing a concise, human-readable description of this
object.
|
|
final
void
|
wait()
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.
|
|
final
void
|
wait(long millis, int nanos)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
|
final
void
|
wait(long millis)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
|
Public Constructors
public
ReferenceQueue
()
Constructs a new instance of this class.
Public Methods
public
synchronized
Reference<? extends T>
poll
()
Returns the next available reference from the queue, removing it in the
process. Does not wait for a reference to become available.
Returns
- the next available reference, or
null if no reference is
immediately available
public
Reference<? extends T>
remove
()
Returns the next available reference from the queue, removing it in the
process. Waits indefinitely for a reference to become available.
public
synchronized
Reference<? extends T>
remove
(long timeoutMillis)
Returns the next available reference from the queue, removing it in the
process. Waits for a reference to become available or the given timeout
period to elapse, whichever happens first.
Parameters
| timeoutMillis
| maximum time to spend waiting for a reference object
to become available. A value of 0 results in the method
waiting indefinitely. |
Returns
- the next available reference, or
null if no reference
becomes available within the timeout period
