Class Reference
java.lang.ref
java.lang.Object
  java.lang.ref.Reference
Direct Known Subclasses:
PhantomReference, SoftReference, WeakReference
abstract public class Reference
extends Object
Abstract base class for reference objects. This class defines the operations common to all reference objects. Because reference objects are implemented in close cooperation with the garbage collector, this class may not be subclassed directly.
Since:
1.2
Version:
1.43, 04/10/06
Author:
Mark Reinhold
Method Summary
void
 clear()
Clears this reference object.
boolean
 enqueue()
Adds this reference object to the queue with which it is registered, if any.
T
 get()
Returns this reference object's referent.
boolean
 isEnqueued()
Tells whether or not this reference object has been enqueued, either by the program or by the garbage collector.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Method Detail
get
public T get()
Returns this reference object's referent. If this reference object has been cleared, either by the program or by the garbage collector, then this method returns null.
Returns:
The object to which this reference refers, or null if this reference object has been cleared
clear
public void clear()
Clears this reference object. Invoking this method will not cause this object to be enqueued.

This method is invoked only by Java code; when the garbage collector clears references it does so directly, without invoking this method.

isEnqueued
public boolean isEnqueued()
Tells whether or not this reference object has been enqueued, either by the program or by the garbage collector. If this reference object was not registered with a queue when it was created, then this method will always return false.
Returns:
true if and only if this reference object has been enqueued
enqueue
public boolean enqueue()
Adds this reference object to the queue with which it is registered, if any.

This method is invoked only by Java code; when the garbage collector enqueues references it does so directly, without invoking this method.

Returns:
true if this reference object was successfully enqueued; false if it was already enqueued or if it was not registered with a queue when it was created
Java API documentation generated with DocFlex/Doclet v1.5.6
DocFlex/Doclet is both a multi-format Javadoc doclet and a free edition of DocFlex/Javadoc. If you need to customize your Javadoc without writing a full-blown doclet from scratch, DocFlex/Javadoc may be the only tool able to help you! Find out more at www.docflex.com