Field Detail

• DELIM

  public static final String DELIM

  See Also:

  Constant Field Values

• DEFAULT_SEARCH_PATH

  public static final String DEFAULT_SEARCH_PATH

  See Also:

  Constant Field Values

Constructor Detail

• NativeLibraryUtil

  public NativeLibraryUtil()

Method Detail

• getArchitecture

  public static NativeLibraryUtil.Architecture getArchitecture()

  Determines the underlying hardware platform and architecture.

  Returns:

  enumerated architecture value

• getPlatformLibraryPath

  public static String getPlatformLibraryPath(String searchPath)

  Returns the path to the native library.

  Parameters:

  searchPath - the path to search for <platform> directory. Pass in null to get default path (natives/<platform>).

  Returns:

  path

• getPlatformLibraryName

  public static String getPlatformLibraryName(String libName)

  Returns the full file name (without path) of the native library.

  Parameters:

  libName - name of library

  Returns:

  file name

• getVersionedLibraryName

  public static String getVersionedLibraryName(Class<?> libraryJarClass,
                                               String libName)

  Returns the Maven-versioned file name of the native library. In order for this to work Maven needs to save its version number in the jar manifest. The version of the library-containing jar and the version encoded in the native library names should agree.

   
   <build>
     <plugins>
       <plugin>
         <artifactId>maven-jar-plugin</artifactId>
           <inherited>true</inherited> *
           <configuration>
              <archive>
                <manifest>
                  <packageName>com.example.package</packageName>
                  <addDefaultImplementationEntries>true</addDefaultImplementationEntries> *
                </manifest>
             </archive>
           </configuration>
       </plugin>
     </plugins>
   </build>
  
   * = necessary to save version information in manifest
   
   

  Parameters:

  libraryJarClass - any class within the library-containing jar

  libName - name of library

  Returns:

  The Maven-versioned file name of the native library.

• loadVersionedNativeLibrary

  public static boolean loadVersionedNativeLibrary(Class<?> libraryJarClass,
                                                   String libName)

  Loads the native library. Picks up the version number to specify from the library-containing jar.

  Parameters:

  libraryJarClass - any class within the library-containing jar

  libName - name of library

  Returns:

  whether or not successful

• loadNativeLibrary

  public static boolean loadNativeLibrary(JniExtractor jniExtractor,
                                          String libName,
                                          String... searchPaths)

  Loads the native library.

  Parameters:

  jniExtractor - the extractor to use

  libName - name of library

  searchPaths - a list of additional paths to search for the library

  Returns:

  whether or not successful

• loadNativeLibrary

  @Deprecated
  public static boolean loadNativeLibrary(Class<?> libraryJarClass,
                                                      String libName)

  Deprecated. 
  Loads the native library.

  Parameters:

  libraryJarClass - any class within the library-containing jar

  libName - name of library

  Returns:

  whether or not successful