Top Description Fields Constructors Methods
java.lang.ref

public non-sealed Class PhantomReference<T>

extends Reference<T>
Class Inheritance
Known Direct Subclasses
jdk.internal.ref.Cleaner, jdk.internal.ref.PhantomCleanable
Type Parameters
<T>
the type of the referent
Imports
jdk.internal.vm.annotation.IntrinsicCandidate

Phantom reference objects, which are enqueued after the collector determines that their referents may otherwise be reclaimed. Phantom references are most often used to schedule post-mortem cleanup actions.

Suppose the garbage collector determines at a certain point in time that an object is phantom reachable. At that time it will atomically clear all phantom references to that object and all phantom references to any other phantom-reachable objects from which that object is reachable. At the same time or at some later time it will enqueue those newly-cleared phantom references that are registered with reference queues.

In order to ensure that a reclaimable object remains so, the referent of a phantom reference may not be retrieved: The get method of a phantom reference always returns null. The refersTo method can be used to test whether some object is the referent of a phantom reference.

Author
Mark Reinhold
Since
1.2

Field Summary

Inherited from java.lang.ref.Reference:
nextqueue

Constructor Summary

AccessConstructor and Description
public
PhantomReference(T
the object the new phantom reference will refer to
referent
,
ReferenceQueue<? super T>
the queue with which the reference is to be registered, or null if registration is not required
q
)

Creates a new phantom reference that refers to the given object and is registered with the given queue.

Method Summary

Modifier and TypeMethod and Description
public T

Returns:

null
get
()

Overrides java.lang.ref.Reference.get.

Returns this reference object's referent.

private native boolean
pack-priv boolean
Inherited from java.lang.ref.Reference:
clearclearInactiveFinalReferencecloneenqueuegetFromInactiveFinalReferenceisEnqueuedreachabilityFencerefersTostartReferenceHandlerThread

Constructor Detail

PhantomReferenceback to summary
public PhantomReference(T referent, ReferenceQueue<? super T> q)

Creates a new phantom reference that refers to the given object and is registered with the given queue.

It is possible to create a phantom reference with a null queue. Such a reference will never be enqueued.

Parameters
referent:T

the object the new phantom reference will refer to

q:ReferenceQueue<? super T>

the queue with which the reference is to be registered, or null if registration is not required

Method Detail

getback to summary
public T get()

Overrides java.lang.ref.Reference.get.

Returns this reference object's referent. Because the referent of a phantom reference is always inaccessible, this method always returns null.

Returns:T

null

refersTo0back to summary
private native boolean refersTo0(Object o)

Hides java.lang.ref.Reference.refersTo0.

Annotations
@IntrinsicCandidate
refersToImplback to summary
pack-priv boolean refersToImpl(T obj)

Overrides java.lang.ref.Reference.refersToImpl.

Annotations
@Override