File Doc Category Size Date Package
PhantomReference.java API Doc Java SE 5 API 2411 Fri Aug 26 14:57:06 BST 2005 java.lang.ref

PhantomReference

java.lang.Object
- java.lang.ref.Reference

public class PhantomReference extends Reference

Phantom reference objects, which are enqueued after the collector determines that their referents may otherwise be reclaimed. Phantom references are most often used for scheduling pre-mortem cleanup actions in a more flexible way than is possible with the Java finalization mechanism.

If the garbage collector determines at a certain point in time that the referent of a phantom reference is phantom reachable, then at that time or at some later time it will enqueue the reference.

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.

Unlike soft and weak references, phantom references are not automatically cleared by the garbage collector as they are enqueued. An object that is reachable via phantom references will remain so until all such references are cleared or themselves become unreachable.

version: 1.19, 12/19/03
author: Mark Reinhold
since: 1.2

Fields Summary
Constructors Summary
public PhantomReference(T referent, ReferenceQueue 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, but such a reference is completely useless: Its get method will always return null and, since it does not have a queue, it will never be enqueued.
param
referent the object the new phantom reference will refer to
param
q the queue with which the reference is to be registered, or null if registration is not required
super(referent, q);
Methods Summary
public T get()
Returns this reference object's referent. Because the referent of a phantom reference is always inaccessible, this method always returns null.
return
null
return null;