java.lang.ref (Java SE 26 & JDK 26)
Description: declaration: module: java.base, package: java.lang.ref
Keywords: java.lang.ref package

# Package java.lang.ref

package java.lang.ref
Provides reference-object classes, which support a limited degree of interaction with the garbage collector. A program may use a reference object to maintain a reference to some other object in such a way that the latter object may still be reclaimed by the collector. A program may also arrange to be notified some time after the collector has determined that the reachability of a given object has changed.

## Reference Objects

A reference object encapsulates a reference to some other object so that the reference itself may be examined and manipulated like any other object. Three types of reference objects are provided, each weaker than the last: soft, weak, and phantom. Each type corresponds to a different level of reachability, as defined below. Soft references are for implementing memory-sensitive caches, weak references are for implementing canonicalizing mappings that do not prevent their keys (or values) from being reclaimed, and phantom references are for scheduling post-mortem cleanup actions. Post-mortem cleanup actions can also be registered and managed by a `Cleaner`.

Each reference-object type is implemented by a subclass of the abstract base `Reference` class. An instance of one of these subclasses encapsulates a single reference to a particular object, called the referent. Every reference object provides methods for getting and clearing the reference. Aside from the clearing operation reference objects are otherwise immutable, so no `set` operation is provided. A program may further subclass these subclasses, adding whatever fields and methods are required for its purposes, or it may use these subclasses without change.

## Reachability

A reachable object is any object that can be accessed in any potential continuing computation from any live thread (as stated in JLS 12.6.1).

Going from strongest to weakest, the different levels of reachability reflect the life cycle of an object. They are operationally defined as follows:

- An object is strongly reachable if it is reachable and if it can be accessed without traversing the referent of a Reference object.
- An object is softly reachable if it is not strongly reachable but can be reached by traversing a soft reference.
- An object is weakly reachable if it is neither strongly nor softly reachable but can be reached by traversing a weak reference. When the weak references to a weakly-reachable object are cleared, the object becomes eligible for finalization.
- An object is phantom reachable if it is neither strongly, softly, nor weakly reachable, it has been finalized, and some phantom reference refers to it.
- Finally, an object is unreachable, and therefore eligible for reclamation, when it is not reachable in any of the above ways.

## Notification

A program may request to be notified of changes in an object's reachability by registering an appropriate reference object with a `ReferenceQueue`. This is done by providing the reference queue as a constructor argument when creating the reference object. Some time after the garbage collector determines that the reachability of the referent has changed to correspond with the type of the reference, it will clear the reference and add it to the associated queue. At this point, the reference is considered to be enqueued. The program learns of the referent's change in reachability when the associated reference becomes available on the queue. The program may remove references from a queue (that is, dequeue them) using the `ReferenceQueue.poll()` or `ReferenceQueue.remove()` methods. Additional state needed to respond to a referent's change in reachability can be stored in the fields of a custom reference subclass, and accessed when the reference is returned from the queue.

The relationship between a registered reference object and its queue is one-sided. That is, a queue does not keep track of the references that are registered with it. If a registered reference becomes unreachable itself, then it will never be enqueued. It is the responsibility of the program to ensure that reference objects remain reachable for as long as the program is interested in their referents.

While some programs will choose to dedicate a thread to removing reference objects from one or more queues and processing them, this is by no means necessary. A tactic that often works well is to examine a reference queue in the course of performing some other fairly-frequent action. For example, a hashtable that uses weak references to implement weak keys could poll its reference queue each time the table is accessed. This is how the `WeakHashMap` class works. Because the `ReferenceQueue.poll` method simply checks an internal data structure, this check will add little overhead to the hashtable access methods.

## Memory Consistency Properties

Certain interactions between references, reference queues, and the garbage collector form happens-before relationships:

- Actions in a thread prior to calling `Reference.reachabilityFence(x)` happen-before the garbage collector clears any reference to `x`.
- The clearing of a reference by the garbage collector happens-before the garbage collector enqueues the reference.
- The enqueueing of a reference (by the garbage collector, or by a successful call to `Reference.enqueue()`) happens-before the reference is removed from the queue (dequeued).
- The dequeuing of a reference to a registered object, by the Cleaner thread, happens-before the Cleaner thread runs the cleaning action for that object.

The above chain of happens-before edges ensures that actions in a thread prior to a `Reference.reachabilityFence(x)` happen-before cleanup code for `x` runs on a Cleaner thread. In particular, changes to the state of `x` made before `reachabilityFence(x)` will be visible to the cleanup code running on a Cleaner thread without additional synchronization. See JLS 17.4.5.

The interaction between references, finalizers, and the garbage collector also forms a happens-before relationship:

- Actions in a thread prior to calling `Reference.reachabilityFence(x)` happen-before the finalizer for `x` is run by a finalizer thread.

This ensures that actions in a thread prior to a `Reference.reachabilityFence(x)` happen-before cleanup code for `x` runs on a finalizer thread. In particular, changes to the state of `x` made before `reachabilityFence(x)` will be visible to the cleanup code running on a finalizer thread without additional synchronization. See JLS 17.4.5.

Since:
  1.2

- Related Packages
  Package
  Description
  java.lang
  Provides classes that are fundamental to the design of the Java programming language.
- Class
  Description
  Cleaner
  `Cleaner` manages a set of object references and corresponding cleaning actions.
  Cleaner.Cleanable
  `Cleanable` represents an object and a cleaning action registered in a `Cleaner`.
  PhantomReference<T>
  Phantom reference objects, which are enqueued after the collector determines that their referents may otherwise be reclaimed.
  Reference<T>
  Abstract base class for reference objects.
  ReferenceQueue<T>
  Reference queues, to which registered reference objects are appended by the garbage collector after the appropriate reachability changes are detected.
  SoftReference<T>
  Soft reference objects, which are cleared at the discretion of the garbage collector in response to memory demand.
  WeakReference<T>
  Weak reference objects, which do not prevent their referents from being made finalizable, finalized, and then reclaimed.