com.kenai.jaffl
Class Library

java.lang.Object
  extended by com.kenai.jaffl.Library

public final class Library
extends Object


Method Summary
static void addLibraryPath(String libraryName, File path)
          Adds a custom search path for a library
static Library getInstance(String libraryName)
           
static List<String> getLibraryPath(String libraryName)
          Gets the custom search path for a library.
 String getName()
          Gets the name of this library
 boolean hasFunction(String function)
          Deprecated. this method is no longer supported.
static
<T> T
loadLibrary(Class<T> interfaceClass, Map<LibraryOption,?> libraryOptions, String... libraryNames)
          Loads a native library and links the methods defined in interfaceClass to native methods in the library.
static
<T> T
loadLibrary(Class<T> interfaceClass, String... libraryNames)
          Loads a native library and links the methods defined in interfaceClass to native methods in the library.
static
<T> T
loadLibrary(String libraryName, Class<T> interfaceClass)
          Loads a native library and links the methods defined in interfaceClass to native methods in the library.
static
<T> T
loadLibrary(String libraryName, Class<T> interfaceClass, Map<LibraryOption,?> libraryOptions)
          Loads a native library and links the methods defined in interfaceClass to native methods in the library.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

loadLibrary

public static <T> T loadLibrary(String libraryName,
                                Class<T> interfaceClass)
Loads a native library and links the methods defined in interfaceClass to native methods in the library.

Parameters:
libraryName - the name of the library to load
interfaceClass - the interface that describes the native library interface
Returns:
an instance of interfaceclass that will call the native methods.

loadLibrary

public static <T> T loadLibrary(Class<T> interfaceClass,
                                String... libraryNames)
Loads a native library and links the methods defined in interfaceClass to native methods in the library.

Parameters:
libraryName - the name of the library to load
interfaceClass - the interface that describes the native library interface
Returns:
an instance of interfaceclass that will call the native methods.

loadLibrary

public static <T> T loadLibrary(String libraryName,
                                Class<T> interfaceClass,
                                Map<LibraryOption,?> libraryOptions)
Loads a native library and links the methods defined in interfaceClass to native methods in the library.

Parameters:
libraryName - the name of the library to load
interfaceClass - the interface that describes the native library interface
libraryOptions - options
Returns:
an instance of interfaceclass that will call the native methods.

loadLibrary

public static <T> T loadLibrary(Class<T> interfaceClass,
                                Map<LibraryOption,?> libraryOptions,
                                String... libraryNames)
Loads a native library and links the methods defined in interfaceClass to native methods in the library.

Parameters:
libraryName - the name of the library to load
interfaceClass - the interface that describes the native library interface
libraryOptions - options
Returns:
an instance of interfaceclass that will call the native methods.

addLibraryPath

public static final void addLibraryPath(String libraryName,
                                        File path)
Adds a custom search path for a library

Parameters:
libraryName - the name of the library to search for
path - the path to search for the library in

getLibraryPath

public static List<String> getLibraryPath(String libraryName)
Gets the custom search path for a library.

Parameters:
libraryName - The library to retrieve the path for.
Returns:
A List of String instances.

getInstance

public static final Library getInstance(String libraryName)

hasFunction

public boolean hasFunction(String function)
Deprecated. this method is no longer supported.

Checks if a specific function exists in the library.

Parameters:
function - The function
Returns:
true if the function exists

getName

public String getName()
Gets the name of this library

Returns:
The name of this library as a String


Copyright © 2011. All Rights Reserved.