Top Description Fields Constructors Methods
org.python.core.finalization

public Class FinalizeTrigger

extends Object
Class Inheritance
Imports
org.python.core.PyObject, .JyAttribute, .PySystemState, org.python.modules.gc

To use finalizers on PyObjects, read the documentation of org.python.core.finalization.FinalizablePyObject.

Field Summary

Modifier and TypeField and Description
public static FinalizeTriggerFactory
factory

This factory hook is reserved for use by JyNI.

public static final byte
FINALIZED_FLAG

Indicates that this trigger was already finalized.

public byte
public static final byte
NOT_FINALIZABLE_FLAG

Indicates that the underlying PyObject was never intended to be finalized.

public static final byte
NOTIFY_GC_FLAG

This flag tells the finalize trigger to call gc#notifyFinalize(PyObject) after it called the finalizer.

public static final byte
protected PyObject

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public static void
public void
public static void
ensureFinalizer(PyObject resurrect)

Recreates the FinalizeTrigger of the given object.

protected void
finalize()

Overrides java.lang.Object.finalize.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

public static boolean
public boolean
protected boolean
public static boolean
public boolean
protected boolean
public static FinalizeTrigger
makeTrigger(PyObject toFinalize)

public void
public static void
runFinalizer(PyObject toFinalize)

public static void
runFinalizer(PyObject toFinalize, boolean runBuiltinOnly)

public void
trigger(PyObject toFinalize)

Inherited from java.lang.Object:
cloneequalsgetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

factoryback to summary
public static FinalizeTriggerFactory factory

This factory hook is reserved for use by JyNI. It allows to replace the default FinalizeTrigger. JyNI needs it to support garbage collection.

FINALIZED_FLAGback to summary
public static final byte FINALIZED_FLAG

Indicates that this trigger was already finalized.

flagsback to summary
public byte flags
NOT_FINALIZABLE_FLAGback to summary
public static final byte NOT_FINALIZABLE_FLAG

Indicates that the underlying PyObject was never intended to be finalized. It is actually not finalizable and the trigger only exists to notify org.python.modules.gc that the underlying object was finalized. This is needed for some advanced gc-functionality.

NOTIFY_GC_FLAGback to summary
public static final byte NOTIFY_GC_FLAG

This flag tells the finalize trigger to call gc#notifyFinalize(PyObject) after it called the finalizer.

ONLY_BUILTIN_FLAGback to summary
public static final byte ONLY_BUILTIN_FLAG

Indicates that only org.python.core.finalization.FinalizableBuiltin shall be called.

toFinalizeback to summary
protected PyObject toFinalize

Constructor Detail

FinalizeTriggerback to summary
protected FinalizeTrigger(PyObject toFinalize)

Method Detail

appendFinalizeTriggerForBuiltinback to summary
public static void appendFinalizeTriggerForBuiltin(PyObject obj)
clearback to summary
public void clear()
ensureFinalizerback to summary
public static void ensureFinalizer(PyObject resurrect)

Recreates the FinalizeTrigger of the given object. This makes sure that once the resurrected object is gc'ed again, its __del__-method will be called again.

finalizeback to summary
protected void finalize() throws Throwable

Overrides java.lang.Object.finalize.

Doc from java.lang.Object.finalize.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

When running in a Java virtual machine in which finalization has been disabled or removed, the garbage collector will never call finalize(). In a Java virtual machine in which finalization is enabled, the garbage collector might call finalize only after an indefinite delay.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Exceptions
Throwable:
the Exception raised by this method
hasActiveTriggerback to summary
public static boolean hasActiveTrigger(PyObject obj)
isActiveback to summary
public boolean isActive()
isCyclicback to summary
protected boolean isCyclic()
isFinalizableback to summary
public static boolean isFinalizable(PyObject obj)
isFinalizedback to summary
public boolean isFinalized()
isUncollectableback to summary
protected boolean isUncollectable()
makeTriggerback to summary
public static FinalizeTrigger makeTrigger(PyObject toFinalize)
performFinalizationback to summary
public void performFinalization()
runFinalizerback to summary
public static void runFinalizer(PyObject toFinalize)
runFinalizerback to summary
public static void runFinalizer(PyObject toFinalize, boolean runBuiltinOnly)
triggerback to summary
public void trigger(PyObject toFinalize)