Modifier and Type	Class and Description
private static class	GlobalRef.RefReaper

Modifier and Type	Field and Description
protected boolean	cleared This boolean is set `true` when the callback is processed.
private static List<GlobalRef>	delayedCallbacks
public static ReferenceBackendFactory	factory This is a hook for JyNI to insert a native-objects-aware implementation of ReferenceBackend.
private int	hashCode This reference's hashCode: The `System.identityHashCode` of the referent.
private boolean	havePythonHashCode Whether `pythonHashCode` was already determined.
private static ConcurrentMap<GlobalRef, ReferenceBackend>	objects
private int	pythonHashCode The public hashCode for the Python AbstractReference wrapper.
private static ReentrantReadWriteLock	reaperLock
private static volatile Thread	reaperThread
private static ReferenceQueue<PyObject>	referenceQueue
private List<WeakReference<AbstractReference>>	references

Access	Constructor and Description
public	GlobalRef(PyObject object)

Method Summary

Modifier and Type	Method and Description
public synchronized void	add(AbstractReference ref) Implements org.python.modules._weakref.ReferenceBackend.add.
pack-priv synchronized void	call() Call each of the registered references.
public synchronized int	count() Implements org.python.modules._weakref.ReferenceBackend.count.
private static void	createReaperThreadIfAbsent()
private static void	delayedCallback(GlobalRef cl) Stores the callback for later processing.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Allow `GlobalRef`s to be used as hashtable-keys.
public synchronized AbstractReference	find(Class<?> cls) Implements org.python.modules._weakref.ReferenceBackend.find. Search for a reusable reference.
public static int	Returns: an int reference count getCount(PyObject a PyObject object) Return the number of references to the specified `org.python.core.PyObject`.
private final AbstractReference	getReferenceAt(int idx)
public static PyList	Returns: a `org.python.core.PyList` of references. May be empty. getRefs(PyObject a `org.python.core.PyObject` object) Return a list of references to the specified `org.python.core.PyObject`.
public static boolean	hasDelayedCallbacks()
public int	Returns: a hashCode `int`-value hashCode() Overrides java.lang.Object.hashCode. Allows `GlobalRef` to be used as hashtable-keys.
private static void	initReaperThread()
public boolean	isCleared() Implements org.python.modules._weakref.ReferenceBackend.isCleared.
public static ReferenceBackend	Returns: a new tracked `ReferenceBackend` newInstance(PyObject a `org.python.core.PyObject` to reference object) Create a new tracked `ReferenceBackend`.
public static void	processDelayedCallbacks() Call all callbacks that were enqueued via `delayedCallback(GlobalRef)` method.
public int	Returns: a hashCode `int`-value pythonHashCode() Implements org.python.modules._weakref.ReferenceBackend.pythonHashCode. The publicly used `hashCode`, for the `org.python.modules._weakref.AbstractReference` wrapper.
public synchronized PyList	refs() Implements org.python.modules._weakref.ReferenceBackend.refs.
public synchronized void	restore(PyObject formerReferent) Implements org.python.modules._weakref.ReferenceBackend.restore. Restores this weak reference to its former referent.
protected synchronized ReferenceBackend	retryFactory() Returns null if nothing is changed.

Field Detail

cleared back to summary

cleared	back to summary
protected boolean cleared This boolean is set `true` when the callback is processed. If the reference is cleared it might potentially be restored until this boolean is set true. If weak reference restoring is activated (c.f. `gc#PRESERVE_WEAKREFS_ON_RESURRECTION`), `AbstractReference#get()` would block until a consistent state is reached (i.e. referent is non-`null` or `cleared == true`). See Also `gc#PRESERVE_WEAKREFS_ON_RESURRECTION`, `AbstractReference#get()`

protected boolean cleared

This boolean is set true when the callback is processed. If the reference is cleared it might potentially be restored until this boolean is set true. If weak reference restoring is activated (c.f. gc#PRESERVE_WEAKREFS_ON_RESURRECTION), AbstractReference#get() would block until a consistent state is reached (i.e. referent is non-null or cleared == true).

See Also: gc#PRESERVE_WEAKREFS_ON_RESURRECTION, AbstractReference#get()

delayedCallbacks	back to summary
private static List<GlobalRef> delayedCallbacks

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

hashCode	back to summary
private int hashCode This reference's hashCode: The `System.identityHashCode` of the referent. Only used internally.

havePythonHashCode	back to summary
private boolean havePythonHashCode Whether `pythonHashCode` was already determined.

objects	back to summary
private static ConcurrentMap<GlobalRef, ReferenceBackend> objects

pythonHashCode	back to summary
private int pythonHashCode The public hashCode for the Python AbstractReference wrapper. Derived from the referent's hashCode.

reaperLock	back to summary
private static ReentrantReadWriteLock reaperLock

reaperThread	back to summary
private static volatile Thread reaperThread

referenceQueue	back to summary
private static ReferenceQueue<PyObject> referenceQueue

references	back to summary
private List<WeakReference<AbstractReference>> references

Constructor Detail

GlobalRef	back to summary
public GlobalRef(PyObject object)

Method Detail

add	back to summary
public synchronized void add(AbstractReference ref) Implements org.python.modules._weakref.ReferenceBackend.add.

call	back to summary
pack-priv synchronized void call() Call each of the registered references.

count	back to summary
public synchronized int count() Implements org.python.modules._weakref.ReferenceBackend.count.

createReaperThreadIfAbsent	back to summary
private static void createReaperThreadIfAbsent()

delayedCallback back to summary

delayedCallback	back to summary
private static void delayedCallback(GlobalRef cl) Stores the callback for later processing. This is needed if weak reference restoration (c.f. `gc#PRESERVE_WEAKREFS_ON_RESURRECTION`) is active. In this case the callback is delayed until it was determined whether a resurrection restored the reference. See Also `gc#PRESERVE_WEAKREFS_ON_RESURRECTION`, `gc#FORCE_DELAYED_WEAKREF_CALLBACKS`

private static void delayedCallback(GlobalRef cl)

Stores the callback for later processing. This is needed if weak reference restoration (c.f. gc#PRESERVE_WEAKREFS_ON_RESURRECTION) is active. In this case the callback is delayed until it was determined whether a resurrection restored the reference.

See Also: gc#PRESERVE_WEAKREFS_ON_RESURRECTION, gc#FORCE_DELAYED_WEAKREF_CALLBACKS

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Allow `GlobalRef`s to be used as hashtable-keys. Parameters o:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Allow GlobalRefs to be used as hashtable-keys.

Parameters

o:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

find	back to summary
public synchronized AbstractReference find(Class<?> cls) Implements org.python.modules._weakref.ReferenceBackend.find. Search for a reusable reference. To be reused, it must be of the same class and it must not have a callback.

find

back to summary

public synchronized AbstractReference find(Class<?> cls)

Implements org.python.modules._weakref.ReferenceBackend.find.

Search for a reusable reference. To be reused, it must be of the same class and it must not have a callback.

getCount back to summary

getCount	back to summary
public static int getCount(PyObject object) Return the number of references to the specified `org.python.core.PyObject`. Parameters object:PyObject a PyObject Returns:int an int reference count

public static int getCount(PyObject object)

Return the number of references to the specified org.python.core.PyObject.

Parameters

object:PyObject: a PyObject

Returns:int

an int reference count

getReferenceAt	back to summary
private final AbstractReference getReferenceAt(int idx)

getRefs back to summary

getRefs	back to summary
public static PyList getRefs(PyObject object) Return a list of references to the specified `org.python.core.PyObject`. Parameters object:PyObject a `org.python.core.PyObject` Returns:PyList a `org.python.core.PyList` of references. May be empty.

public static PyList getRefs(PyObject object)

Return a list of references to the specified org.python.core.PyObject.

Parameters

object:PyObject: a org.python.core.PyObject

Returns:PyList

a org.python.core.PyList of references. May be empty.

hasDelayedCallbacks	back to summary
public static boolean hasDelayedCallbacks()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Allows `GlobalRef` to be used as hashtable-keys. Returns:int a hashCode `int`-value

public int hashCode()

Overrides java.lang.Object.hashCode.

Allows GlobalRef to be used as hashtable-keys.

Returns:int: a hashCode int-value

initReaperThread	back to summary
private static void initReaperThread()

isCleared	back to summary
public boolean isCleared() Implements org.python.modules._weakref.ReferenceBackend.isCleared.

newInstance back to summary

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

public static ReferenceBackend newInstance(PyObject object)

Create a new tracked ReferenceBackend. If no ReferenceBackendFactory is registered, it actually returns a GlobalRef.

Parameters

object:PyObject: a org.python.core.PyObject to reference

Returns:ReferenceBackend

a new tracked ReferenceBackend

processDelayedCallbacks back to summary

processDelayedCallbacks	back to summary
public static void processDelayedCallbacks() Call all callbacks that were enqueued via `delayedCallback(GlobalRef)` method. See Also `delayedCallback(GlobalRef)`

public static void processDelayedCallbacks()

Call all callbacks that were enqueued via delayedCallback(GlobalRef) method.

See Also: delayedCallback(GlobalRef)

pythonHashCode back to summary

pythonHashCode	back to summary
public int pythonHashCode() Implements org.python.modules._weakref.ReferenceBackend.pythonHashCode. The publicly used `hashCode`, for the `org.python.modules._weakref.AbstractReference` wrapper. Returns:int a hashCode `int`-value

public int pythonHashCode()

Implements org.python.modules._weakref.ReferenceBackend.pythonHashCode.

The publicly used hashCode, for the org.python.modules._weakref.AbstractReference wrapper.

Returns:int: a hashCode int-value

refs	back to summary
public synchronized PyList refs() Implements org.python.modules._weakref.ReferenceBackend.refs.

restore back to summary

restore	back to summary
public synchronized void restore(PyObject formerReferent) Implements org.python.modules._weakref.ReferenceBackend.restore. Restores this weak reference to its former referent. This actually means that a fresh `GlobalRef` is created and inserted into all adjacent `org.python.modules._weakref.AbstractReference`s. The current `GlobalRef` is disbanded. If the given `org.python.core.PyObject` is not the former referent of this weak reference, an `java.lang.IllegalArgumentException` is thrown. Exceptions IllegalArgumentException: if `formerReferent` is not the actual former referent.

public synchronized void restore(PyObject formerReferent)

Implements org.python.modules._weakref.ReferenceBackend.restore.

Restores this weak reference to its former referent. This actually means that a fresh GlobalRef is created and inserted into all adjacent org.python.modules._weakref.AbstractReferences. The current GlobalRef is disbanded. If the given org.python.core.PyObject is not the former referent of this weak reference, an java.lang.IllegalArgumentException is thrown.

Exceptions

IllegalArgumentException:: if formerReferent is not the actual former referent.

retryFactory back to summary

retryFactory	back to summary
protected synchronized ReferenceBackend retryFactory() Returns null if nothing is changed. If a factory exists and produces a result different from `this`, this result is returned. Also, this result is then installed in all weak-references, in the referent's JyAttribute and in the objects-map to act as a proxy for this GlobalRef, which will still serve as a backend for the proxy. This method is most likely used exclusively by JyNI.

protected synchronized ReferenceBackend retryFactory()

Returns null if nothing is changed. If a factory exists and produces a result different from this, this result is returned. Also, this result is then installed in all weak-references, in the referent's JyAttribute and in the objects-map to act as a proxy for this GlobalRef, which will still serve as a backend for the proxy. This method is most likely used exclusively by JyNI.

org.python.modules._weakref back to summary

private Class GlobalRef.RefReaper

Class Inheritance

extends Object
implements Runnable, Callable<Void>

java.lang.Object
org.python.modules._weakref.GlobalRef.RefReaper

All Implemented Interfaces

java.util.concurrent.Callable, java.lang.Runnable

Field Summary

Modifier and Type	Field and Description
private volatile boolean	exit
private Thread	thread

Constructor Summary

Access	Constructor and Description
private	RefReaper()

Method Summary

Modifier and Type	Method and Description
public Void	call() Implements java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so.
public void	collect()
public void	run() Implements java.lang.Runnable.run. Runs this operation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

exit	back to summary
private volatile boolean exit

thread	back to summary
private Thread thread

Constructor Detail

RefReaper	back to summary
private RefReaper()

Method Detail

call	back to summary
public Void call() throws Exception Implements java.util.concurrent.Callable.call. Doc from java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so. Returns:Void computed result Annotations @Override Exceptions Exception: if unable to compute a result

call

back to summary

public Void call() throws Exception

Implements java.util.concurrent.Callable.call.

Doc from java.util.concurrent.Callable.call.

Computes a result, or throws an exception if unable to do so.

Returns:Void

computed result

Annotations