Package java.lang.ref
Class Reference<T>
- java.lang.Object
-
- java.lang.ref.Reference<T>
-
- Type Parameters:
T- the type of the referenced object
- Direct Known Subclasses:
WeakReference
public abstract class Reference<T> 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.
-
-
Constructor Summary
Constructors Constructor Description Reference()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear()Clears this reference object.booleanenqueue()Adds this reference object to the queue with which it is registered, if any.Tget()Returns this reference object's referent.booleanisEnqueued()Tells whether or not this reference object has been enqueued, either by the program or by the garbage collector.
-
-
-
Method Detail
-
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.
-
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:
trueif this reference object was successfully enqueued;falseif it was already enqueued or if it was not registered with a queue when it was created
-
get
@Nullable 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 returnsnull.- Returns:
- The object to which this reference refers, or
nullif this reference object has been cleared
-
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 returnfalse.- Returns:
trueif and only if this reference object has been enqueued
-
-