All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface cryptix.util.core.LinkStatus

public interface LinkStatus
A class providing information about the linking status of a native library (whether it was loaded successfully, its required and actual version numbers, etc.)

The status of a library used by a particular Cryptix class can be found by calling the static method getLinkStatus() on that class.

Copyright © 1997 Systemics Ltd on behalf of the Cryptix Development Team.
All rights reserved.

Author:
David Hopwood

Method Index

 o checkNative()
Checks that the native library is being used (i.e.
 o getLibraryName()
Returns the library name.
 o getLinkErrorString()
Returns an error string describing why the library failed to load, or null if there was no error.
 o getMajorVersion()
Returns the actual major version number.
 o getMinorVersion()
Returns the actual minor version number.
 o getRequiredMajorVersion()
Returns the required major version number.
 o getRequiredMinorVersion()
Returns the required minor version number.
 o isLibraryCorrect()
Returns true if the library was loaded successfully.
 o isLibraryLoaded()
Returns true if the library was loaded.
 o setNative(boolean)
Enables or disables the native code.
 o useNative()
Returns true if native code is being used.

Methods

 o getRequiredMajorVersion
 public abstract int getRequiredMajorVersion()
Returns the required major version number.

 o getRequiredMinorVersion
 public abstract int getRequiredMinorVersion()
Returns the required minor version number.

 o getLibraryName
 public abstract String getLibraryName()
Returns the library name.

 o getMajorVersion
 public abstract int getMajorVersion()
Returns the actual major version number.

 o getMinorVersion
 public abstract int getMinorVersion()
Returns the actual minor version number.

 o isLibraryLoaded
 public abstract boolean isLibraryLoaded()
Returns true if the library was loaded. It may or may not be the correct version.

 o isLibraryCorrect
 public abstract boolean isLibraryCorrect()
Returns true if the library was loaded successfully.

 o useNative
 public abstract boolean useNative()
Returns true if native code is being used.

 o getLinkErrorString
 public abstract String getLinkErrorString()
Returns an error string describing why the library failed to load, or null if there was no error.

Returns:
the error string, or null if no error occured
 o checkNative
 public abstract void checkNative() throws UnsatisfiedLinkError
Checks that the native library is being used (i.e. it loaded successfully, has valid version numbers, and has not been disabled).

Throws: UnsatisfiedLinkError
if the library is not being used
 o setNative
 public abstract void setNative(boolean enable)
Enables or disables the native code. By default, native code is used whenever its library can be loaded correctly. This method can be used to disable native linking (and re-enable it) for a specific class.

Parameters:
enable - true if native code should be used.

All Packages  Class Hierarchy  This Package  Previous  Next  Index