cli

Class NativeObject

java.lang.Object

cli.NativeObject

Direct Known Subclasses:

CommandLine, Element, ExecutionContext.Common, ExecutionResult, OutputDevice.Common, OutputDevice.ScreenInfo, ResourceString, TelnetServer, TraceClass

public abstract class NativeObject
extends java.lang.Object

Java object corresponding to a native object class. When a Java instance corresponds to a native instance, it should inherit from this class. NativeObject allows automatic native object destruction when the garbage collector frees the Java instance. NativeObject also offers a service that allows Java instances to be still referenced even though they would normally be destroyed by the garbage collector on Java side. However, since the object is still useful on native side, it should be remembered. A 'forget' service is also provided to balance the 'remember' service.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NativeObject(long I64_NativeRef) Constructor.

Method Summary

Modifier and Type	Method and Description
protected static void	createdFromNative(NativeObject CLI_Object) To be called by native created objects.
void	dontFinalize() Call this method for Java objects which native objects should not be destroyed from Java code on finalization.
protected void	finalize() Destructor.
static void	forget(NativeObject CLI_NativeObject) Java instances to be forgotten (native object can now be destroyed) should be dereferenced with this method.
boolean	getbDoFinalize() Accessor to be used in order to know whether the native instance instance should be destroyed or not.
long	getNativeRef() Native reference accessor.
static NativeObject	getObject(long I64_NativeRef) Find the Java instance from its native instance reference.
static void	remember(NativeObject CLI_NativeObject) Java instances to be remembered for native object consistency should be referenced with this method.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NativeObject

protected NativeObject(long I64_NativeRef)

Constructor.

Parameters:

I64_NativeRef - Native instance reference corresponding to this Java instance.

Method Detail

createdFromNative

protected static final void createdFromNative(NativeObject CLI_Object)

To be called by native created objects.

Parameters:

CLI_Object - Object created.

finalize

protected void finalize()
                 throws java.lang.Throwable

Destructor.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getNativeRef

public final long getNativeRef()

Native reference accessor.

Returns:

The native reference of the instance.

getbDoFinalize

public final boolean getbDoFinalize()

Accessor to be used in order to know whether the native instance instance should be destroyed or not.

Returns:

true if the native instance should be destroyed on finalization, false otherwise.

dontFinalize

public final void dontFinalize()

Call this method for Java objects which native objects should not be destroyed from Java code on finalization.

remember

public static final void remember(NativeObject CLI_NativeObject)

Java instances to be remembered for native object consistency should be referenced with this method.

Parameters:

CLI_NativeObject - Instance to remember.

forget

public static final void forget(NativeObject CLI_NativeObject)

Java instances to be forgotten (native object can now be destroyed) should be dereferenced with this method.

Parameters:

CLI_NativeObject - Instance to forget.

getObject

public static NativeObject getObject(long I64_NativeRef)

Find the Java instance from its native instance reference.

Parameters:

I64_NativeRef - Native instance reference corresponding to the searched Java instance.

Returns:

The corresponding native instance if found, null otherwise.