You are currently viewing a snapshot of taken on April 21, 2008. Most of this content is highly out of date (some pages haven't been updated since the project began in 1998) and exists for historical purposes only. If there are any pages on this archive site that you think should be added back to, please file a bug.

Class NativeProxy

  extended by org.mozilla.jss.util.NativeProxy
Direct Known Subclasses:

public abstract class NativeProxy
extends java.lang.Object

NativeProxy, a superclass for Java classes that mirror C data structures. It contains some code to help make sure that native memory is getting freed properly.

Constructor Summary
NativeProxy(byte[] pointer)
          Create a NativeProxy from a byte array representing a C pointer.
Method Summary
static void assertRegistryEmpty()
          Assert that the Registry is empty.
 boolean equals(java.lang.Object obj)
          Deep comparison operator.
protected  void finalize()
          Finalize this NativeProxy by releasing its native resources.
 long getRegistryIndex()
static java.util.Enumeration getRegistryIndices()
protected abstract  void releaseNativeResources()
          Release the native resources used by this proxy.
Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public NativeProxy(byte[] pointer)
Create a NativeProxy from a byte array representing a C pointer. This is the only way to create a NativeProxy, it should be called from the constructor of your subclass.

pointer - A byte array, created with JSS_ptrToByteArray, that contains a pointer pointing to a native data structure. The NativeProxy instance acts as a proxy for that native data structure.
Method Detail


public boolean equals(java.lang.Object obj)
Deep comparison operator.

equals in class java.lang.Object
true if obj has the same underlying native pointer. false if the obj is null or has a different underlying native pointer.


protected abstract void releaseNativeResources()
Release the native resources used by this proxy. Subclasses of NativeProxy must define this method to clean up data structures in C code that are referenced by this proxy. releaseNativeResources() will usually be implemented as a native method.

You don't call this method; NativeProxy.finalize() calls it for you.

You must declare a finalize() method which calls super.finalize().


protected void finalize()
                 throws java.lang.Throwable
Finalize this NativeProxy by releasing its native resources. The finalizer calls releaseNativeResources() so you don't have to. This finalizer should be called from the finalize() method of all subclasses: class MyProxy extends NativeProxy { [...] protected void finalize() throws Throwable { // do any object-specific finalization other than // releasing native resources [...] super.finalize(); } }

finalize in class java.lang.Object


public static java.util.Enumeration getRegistryIndices()
A list of the indices in the registry. Each element is a Long.
See Also:


public long getRegistryIndex()
The index of this NativeProxy in the NativeProxy registry.
See Also:


public static void assertRegistryEmpty()
Assert that the Registry is empty. Only works in debug mode; in ship mode, it is a no-op. If the Registry is not empty when this is called, an assertion (org.mozilla.jss.util.AssertionException) is thrown.