W3cubDocs

/OpenJDK 21

Class WeakReference<T>

java.lang.Object
java.lang.ref.Reference<T>
java.lang.ref.WeakReference<T>
Type Parameters:
T - the type of the referent
public non-sealed class WeakReference<T> extends Reference<T>
Weak reference objects, which do not prevent their referents from being made finalizable, finalized, and then reclaimed. Weak references are most often used to implement canonicalizing mappings.

Suppose that the garbage collector determines at a certain point in time that an object is weakly reachable. At that time it will atomically clear all weak references to that object and all weak references to any other weakly-reachable objects from which that object is reachable through a chain of strong and soft references. At the same time it will declare all of the formerly weakly-reachable objects to be finalizable. At the same time or at some later time it will enqueue those newly-cleared weak references that are registered with reference queues.

Since:
1.2

Constructor Summary

Constructor Description
WeakReference(T referent)
Creates a new weak reference that refers to the given object.
WeakReference(T referent, ReferenceQueue<? super T> q)
Creates a new weak reference that refers to the given object and is registered with the given queue.

Method Summary

Methods declared in class java.lang.ref.Reference

clear, clone, enqueue, get, isEnqueued, reachabilityFence, refersTo

Methods declared in class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WeakReference

public WeakReference(T referent)
Creates a new weak reference that refers to the given object. The new reference is not registered with any queue.
Parameters:
referent - object the new weak reference will refer to

WeakReference

public WeakReference(T referent, ReferenceQueue<? super T> q)
Creates a new weak reference that refers to the given object and is registered with the given queue.
Parameters:
referent - object the new weak reference will refer to
q - the queue with which the reference is to be registered, or null if registration is not required

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/ref/WeakReference.html