Package org.sosy_lab.common

Class NativeLibraries

java.lang.Object

org.sosy_lab.common.NativeLibraries

public final class NativeLibraries
extends Object

Helper class for loading native libraries. The methods in this class search for the library binary in some more directories than those specified in the java.library.path system property.

The searched directories are:

• the "native library path" as returned by getNativeLibraryPath(), which is the directory ../native/<arch>-<os>/ relative to the JAR file of this library, where <arch> stands for your processor architecture and <os> for the operating system.

  Possible values for <arch> include:

  • arm64
  • x86_64
  • x86

  Possible values for <os> include:

  • linux
  • windows
  • macosx
  • freebsd
  • netbsd
  • openbsd
• the same directory as the JAR file of this library

Standard usage is by calling the method loadLibrary(java.lang.String) with the library name, or use Classes.makeExtendedURLClassLoader() and Classes.ClassLoaderBuilder.setCustomLookupNativeLibraries(java.util.function.Predicate) if third-party code loads the library.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NativeLibraries.Architecture	Deprecated.
static enum	NativeLibraries.OS	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Optional<Path>	findPathForLibrary(String libraryName)	Deprecated.
static Path	getNativeLibraryPath()	Return the "native library path" as defined in the documentation of NativeLibraries, i.e., a directory where members of this class expect native binaries.
static void	loadLibrary(String name)	Load a native library.

Methods inherited from class java.lang.Object

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

Method Details

getNativeLibraryPath

public static Path getNativeLibraryPath()

Return the "native library path" as defined in the documentation of NativeLibraries, i.e., a directory where members of this class expect native binaries.

It is usually recommended to use the high-level method loadLibrary(String) instead.

loadLibrary

public static void loadLibrary(String name)

Load a native library. This is similar to System.loadLibrary(String), but first searches for the library in some other directories (as explained in NativeLibraries). If the library cannot be found there, it falls back to System.loadLibrary(String), which looks in the directories specified in the java.library.path system property.

If you cannot replace the call to System.loadLibrary(String), you can use a class loader created with Classes.makeExtendedURLClassLoader() and Classes.ClassLoaderBuilder.setCustomLookupNativeLibraries(java.util.function.Predicate) to let System.loadLibrary(String) use the same lookup mechanism as this method.

Parameters:

name - A library name as for System.loadLibrary(String).

findPathForLibrary

@Deprecated
public static Optional<Path> findPathForLibrary(String libraryName)

Deprecated.

Search for a native library in some directories as listed in the documentation of NativeLibraries.

Parameters:

libraryName - A library name as for System.loadLibrary(String).

Returns:

Found path or Optional.empty()