Skip to content

Most visited

Recently visited

navigation
Added in API level 1

Reference

public abstract class Reference
extends Object

java.lang.Object
   ↳ java.lang.ref.Reference<T>
Known Direct Subclasses


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.

Summary

Public methods

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.

Inherited methods

From class java.lang.Object

Public methods

clear

Added in API level 1
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

Added in API level 1
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
boolean 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

get

Added in API level 1
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
T The object to which this reference refers, or null if this reference object has been cleared

isEnqueued

Added in API level 1
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
boolean true if and only if this reference object has been enqueued
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.