com.github.strikerx3.jxinput.natives

Class NativeLibraryHelper

java.lang.Object

com.github.strikerx3.jxinput.natives.NativeLibraryHelper

public class NativeLibraryHelper
extends Object

Helper class to facilitate loading native libraries that are included in the .jar file. Libraries are expected to be within a folder in the classpath and their naming should be as follows:

 <library-path>/<os>-<arch>/<lib-prefix><lib-name>[<debug-suffix>].<ext>
 

where:

• library-path is specified by the user on the load(String, String) method
• os is one of:
  • win on Windows platforms
  • linux on Linux platforms
  • unix on UNIX-like platforms
  • mac on Mac OS platforms
  • other on other platforms
• arch is either x86 or x64
• lib-prefix is either lib or nothing, depending on the platform (typically Linux and UNIX-like platforms adopt lib, whereas Windows platforms do not use a prefix)
• lib-name is the library name, specified by the user on the load(String, String) method
• ext is the library extension, according to the platform standards (dll on Windows, so on Linux and UNIX-like platforms, and dylib on Mac OS)
• debug-suffix is an optional debug suffix for the debug versions of the libraries. The debug versions can be loaded by setting the system property native.debug to true. The default debug suffix is "-d" and can be changed through the system property native.debug.suffix

Files are extracted to the path specified by the system property native.lib.path. If the property is not specified, libraries will be extracted to the lib folder under the working directory.

Method Summary

Modifier and Type	Method and Description
static void	load(String path, String libName) Loads a native library using the system class loader.
static void	load(String path, String libName, ClassLoader cl) Loads a native library using the given class loader.

Methods inherited from class java.lang.Object

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

Method Detail

load

public static void load(String path,
                        String libName)
                 throws IOException

Loads a native library using the system class loader.

Parameters:

path - the base path for the library

libName - the library name

Throws:

IOException - if there is a problem reading or writing the library

load

public static void load(String path,
                        String libName,
                        ClassLoader cl)
                 throws IOException

Loads a native library using the given class loader.

Parameters:

path - the base path for the library

libName - the library name

cl - the ClassLoader to use to load the library

Throws:

IOException - if there is a problem reading or writing the library