Package org.jboss.util

Class WeakObject

  • public final class WeakObject
extends java.lang.ref.WeakReference
    Convenience class to wrap an Object into a WeakReference.

    Modified from java.util.WeakHashMap.WeakKey.

    Version:
    $Revision$

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int hashCode
      The hash code of the nested object

    • Constructor Summary

      Constructors 
      Constructor Description
      WeakObject​(java.lang.Object obj)
      Construct a WeakObject.
      WeakObject​(java.lang.Object obj, java.lang.ref.ReferenceQueue queue)
      Construct a WeakObject.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static WeakObject create​(java.lang.Object obj)
      Create a WeakObject for the given object.
      static WeakObject create​(java.lang.Object obj, java.lang.ref.ReferenceQueue queue)
      Create a WeakObject for the given object.
      boolean equals​(java.lang.Object obj)
      Check the equality of an object with this.
      int hashCode()
      Return the hash code of the nested object.

      • Methods inherited from class java.lang.ref.Reference

        clear, clone, enqueue, get, isEnqueued, reachabilityFence

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • hashCode

        protected final int hashCode
        The hash code of the nested object

    • Constructor Detail

      • WeakObject

        public WeakObject​(java.lang.Object obj)
        Construct a WeakObject.
        Parameters:
        obj - Object to reference.

      • WeakObject

        public WeakObject​(java.lang.Object obj,
                  java.lang.ref.ReferenceQueue queue)
        Construct a WeakObject.
        Parameters:
        obj - Object to reference.
        queue - Reference queue.

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object obj)
        Check the equality of an object with this.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - Object to test equality with.
        Returns:
        True if object is equal.

      • hashCode

        public int hashCode()
        Return the hash code of the nested object.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        The hash code of the nested object.

      • create

        public static WeakObject create​(java.lang.Object obj)
        Create a WeakObject for the given object.
        Parameters:
        obj - Object to reference.
        Returns:
        WeakObject or null if object is null.

      • create

        public static WeakObject create​(java.lang.Object obj,
                                java.lang.ref.ReferenceQueue queue)
        Create a WeakObject for the given object.
        Parameters:
        obj - Object to reference.
        queue - Reference queue.
        Returns:
        WeakObject or null if object is null.