J2Native

java.lang.Object
|
+--com.smardec.j2native.Library

public class Library

extends java.lang.Object

Library class is Java representation of the native library. This class is used to load native library and locate it's functions. There is two types of libraries: first - is part of the J2Native system, and must be loaded at the very begining, second - all other libraries.

See Also:

Function, LibraryLoader

Field Summary
static Library	FAKE_LIBRARY
static java.lang.String	LIBRARY_ENFORCE_KEY This is a key to search through system properties.

Constructor Summary

Library(java.lang.String name) Library constructor.

Method Summary
static void	ensureNativeCodeLoaded() Check if native part of J2Native is loaded, and loads it if needed.
Function	getFunction(java.lang.String functionName) Locate and returns Function with specified name.
static LibraryLoader	getLibraryLoader() Returns default LibraryLoader.
java.lang.String	getName() Returns library name.
boolean	isLoaded() Returns if library loaded.
void	load() Loads library.
void	load(java.io.File directory) Loads library from specified directory.
void	load(LibraryLoader loader) Loads library using specified LibraryLoader.
static void	loadNativeCode() Loads J2Native library, that is native part of the wrapper system.
static void	loadNativeCode(LibraryLoader loader) Loads J2Native library, that is native part of the wrapper system.
static void	loadNativeCode(LibraryLoader loader, java.lang.String nativeCodePath) Loads J2Native library, that is native part of the wrapper system.
static void	loadNativeCode(java.lang.String nativeCodePath) Loads J2Native library, that is native part of the wrapper system.
static void	setLibraryLoader(LibraryLoader libraryLoader) Sets default LibraryLoader.
void	unload() Unloads library and frees resources used by library.

Methods inherited from class java.lang.Object

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

Field Detail

LIBRARY_ENFORCE_KEY
public static final java.lang.String LIBRARY_ENFORCE_KEY

This is a key to search through system properties. If System.getProperty(LIBRARY_ENFORCE_KEY) is null or something different than true then no library searching will be performed. Underlie system is responsible for library location.

See Also:

Constant Field Values

Library constructor.

Parameters:

name - filename of the library

Loads J2Native library, that is native part of the wrapper system.

Parameters:

loader - LibraryLoader that will load library

nativeCodePath - path to the library

Throws:

java.lang.SecurityException - if something goes wrong

Loads J2Native library, that is native part of the wrapper system.

Parameters:

loader - LibraryLoader that will load library

Throws:

java.lang.SecurityException

java.lang.UnsatisfiedLinkError

Loads J2Native library, that is native part of the wrapper system.

Parameters:

nativeCodePath - path to the library

Throws:

java.lang.SecurityException

java.lang.UnsatisfiedLinkError

Loads J2Native library, that is native part of the wrapper system.

Throws:

java.lang.SecurityException

java.lang.UnsatisfiedLinkError

Check if native part of J2Native is loaded, and loads it if needed.

Loads library.

Throws:

LibraryNotFoundException - if no library found in path.

Loads library from specified directory.

Parameters:

directory - directory from which library will be loaded

Throws:

LibraryNotFoundException - if no such library found in specified directory

Loads library using specified LibraryLoader.

Parameters:

loader - LibraryLoader used to load library

Throws:

LibraryNotFoundException - if no such library found in path

Unloads library and frees resources used by library.

Returns if library loaded.

Returns:

boolean

Returns library name.

Returns:

library name

Locate and returns Function with specified name.

Parameters:

functionName - name of the function

Throws:

FunctionNotFoundException - if no such function found in this library

Returns default LibraryLoader.

Returns:

LibraryLoader

Sets default LibraryLoader.

Parameters:

libraryLoader - default loader