This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
java.lang.ref
class PhantomReference
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.
Constructor Summary |
Creates a new phantom reference that refers to the given object and
is registered with the given queue.
|
Method Summary |
Object |
Returns this reference object's referent.
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PhantomReference
public PhantomReference(Object 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.
- Parameters:
referent
- the object the new phantom reference will refer to
q
- the queue with which the reference is to be registered,
or null if registration is not required
get
public Object get()
-
Returns this reference object's referent. Because the referent of a
phantom reference is always inaccessible, this method always returns
null
.
- Overrides:
get
in class Reference
- Returns:
null
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.