Stay organized with collections
    
    
      
      Save and categorize content based on your preferences.
    
  
  
    
  
  
  
  
    
  
  
    
    
  
  
WeakReference
  public
  
  
  
  class
  WeakReference
  
  
  
  
    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.
Summary
| Public constructors | 
|---|
  
  
  
    | 
      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.
        
    
 | 
  
| Inherited methods | 
|---|
| 
    From class
      
        
          java.lang.ref.Reference
        
      
      
  
  
  
    | 
        
        
        
        
        
        void | 
      clear()
      Clears this reference object.
        
    
 |  
  
  
    | 
        
        
        
        
        
        Object | 
      clone()
      Throws CloneNotSupportedException. |  
  
  
    | 
        
        
        
        
        
        boolean | 
      enqueue()
      Adds this reference object to the queue with which it is registered,
 if any.
        
    
 |  
  
  
    | 
        
        
        
        
        
        T | 
      get()
      Returns this reference object's referent.
        
    
 |  
  
  
    | 
        
        
        
        
        
        boolean | 
      isEnqueued()
      
      This method was deprecated
      in API level 31.
    This method was never implemented to test if a reference object has
 been cleared and enqueued as it was previously specified since 1.2.
 This method could be misused due to the inherent race condition
 or without an associated ReferenceQueue.
 An application relying on this method to release critical resources
 could cause serious performance issue.
 An application should useReferenceQueueto reliably determine
 what reference objects that have been enqueued orrefersTo(null)to determine if this reference
 object has been cleared. |  
  
  
    | 
        
        
        static
        
        
        void | 
      reachabilityFence(Object ref)
      Ensures that the object referenced by the given reference remains
 strongly reachable,
 regardless of any prior actions of the program that might otherwise cause
 the object to become unreachable; thus, the referenced object is not
 reclaimable by garbage collection at least until after the invocation of
 this method.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        boolean | 
      refersTo(T obj)
      Tests if the referent of this reference object is obj. |  | 
| 
    From class
      
        
          java.lang.Object
        
      
      
  
  
  
    | 
        
        
        
        
        
        Object | 
      clone()
      Creates and returns a copy of this object.
        
    
 |  
  
  
    | 
        
        
        
        
        
        boolean | 
      equals(Object obj)
      Indicates whether some other object is "equal to" this one.
        
    
 |  
  
  
    | 
        
        
        
        
        
        void | 
      finalize()
      Called by the garbage collector on an object when garbage collection
 determines that there are no more references to the object.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        Class<?> | 
      getClass()
      Returns the runtime class of this Object. |  
  
  
    | 
        
        
        
        
        
        int | 
      hashCode()
      Returns a hash code value for the object.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      notify()
      Wakes up a single thread that is waiting on this object's
 monitor.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      notifyAll()
      Wakes up all threads that are waiting on this object's monitor.
        
    
 |  
  
  
    | 
        
        
        
        
        
        String | 
      toString()
      Returns a string representation of the object.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      wait(long timeoutMillis, int nanos)
      Causes the current thread to wait until it is awakened, typically
 by being notified or interrupted, or until a
 certain amount of real time has elapsed.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      wait(long timeoutMillis)
      Causes the current thread to wait until it is awakened, typically
 by being notified or interrupted, or until a
 certain amount of real time has elapsed.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      wait()
      Causes the current thread to wait until it is awakened, typically
 by being notified or interrupted.
        
    
 |  | 
Public constructors
    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 | T: 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 | T: object the new weak reference will refer to | 
      
        | q | ReferenceQueue: the queue with which the reference is to be registered,
          ornullif registration is not required | 
    
 
 
 
  
  
    
  
 
  
    
    
      
       
    
    
  
  
  Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
  Last updated 2025-02-10 UTC.
  
  
  
    
      [null,null,["Last updated 2025-02-10 UTC."],[],[]]