Package org.python.modules._weakref

Class GlobalRef

java.lang.Object
java.lang.ref.Reference<T>
java.lang.ref.WeakReference<PyObject>
org.python.modules._weakref.GlobalRef
All Implemented Interfaces:
ReferenceBackend
public class GlobalRef extends WeakReference<PyObject> implements ReferenceBackend

  • Field Details

    • factory

      public static ReferenceBackendFactory factory
      This is a hook for JyNI to insert a native-objects-aware implementation of ReferenceBackend.

  • Constructor Details

    • GlobalRef

      public GlobalRef(PyObject object)

  • Method Details

    • add

      public void add(AbstractReference ref)
      Specified by:
      add in interface ReferenceBackend

    • find

      public AbstractReference find(Class<?> cls)
      Search for a reusable reference. To be reused, it must be of the same class and it must not have a callback.
      Specified by:
      find in interface ReferenceBackend

    • processDelayedCallbacks

      public static void processDelayedCallbacks()
      Call all callbacks that were enqueued via delayedCallback(GlobalRef) method.
      See Also:
      • delayedCallback(GlobalRef)

    • hasDelayedCallbacks

      public static boolean hasDelayedCallbacks()

    • isCleared

      public boolean isCleared()
      Specified by:
      isCleared in interface ReferenceBackend

    • count

      public int count()
      Specified by:
      count in interface ReferenceBackend

    • refs

      public PyList refs()
      Specified by:
      refs in interface ReferenceBackend

    • newInstance

      public static ReferenceBackend newInstance(PyObject object)
      Create a new tracked ReferenceBackend. If no ReferenceBackendFactory is registered, it actually returns a GlobalRef.
      Parameters:
      object - a PyObject to reference
      Returns:
      a new tracked ReferenceBackend

    • restore

      public void restore(PyObject formerReferent)
      Restores this weak reference to its former referent. This actually means that a fresh GlobalRef is created and inserted into all adjacent AbstractReferences. The current GlobalRef is disbanded. If the given PyObject is not the former referent of this weak reference, an IllegalArgumentException is thrown.
      Specified by:
      restore in interface ReferenceBackend
      Throws:
      IllegalArgumentException - if formerReferent is not the actual former referent.

    • getCount

      public static int getCount(PyObject object)
      Return the number of references to the specified PyObject.
      Parameters:
      object - a PyObject
      Returns:
      an int reference count

    • getRefs

      public static PyList getRefs(PyObject object)
      Return a list of references to the specified PyObject.
      Parameters:
      object - a PyObject
      Returns:
      a PyList of references. May be empty.

    • equals

      public boolean equals(Object o)
      Allow GlobalRefs to be used as hashtable-keys.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Allows GlobalRef to be used as hashtable-keys.
      Overrides:
      hashCode in class Object
      Returns:
      a hashCode int-value

    • pythonHashCode

      public int pythonHashCode()
      The publicly used hashCode, for the AbstractReference wrapper.
      Specified by:
      pythonHashCode in interface ReferenceBackend
      Returns:
      a hashCode int-value