Package jnr.ffi
Enum LibraryOption
- All Implemented Interfaces:
Serializable
,Comparable<LibraryOption>
Options that apply to a library
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe type of calling convention.A function mapper which maps from java function names to native function names.Function calls should NOT save the errno/last error after the call.Load the library into memory immediately, instead of lazily loading itRelevant for GNU/LinuxPlatform.Linux
only Prefer custom paths over system paths when loading a library, even if the custom path has a lower version.Function calls should save the errno/last error after the call.A type mapper which maps java types to native types is present. -
Method Summary
Modifier and TypeMethodDescriptionstatic LibraryOption
Returns the enum constant of this type with the specified name.static LibraryOption[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
SaveError
Function calls should save the errno/last error after the call. This option can be overridden on individual methods by use of theIgnoreError
annotation.- See Also:
-
IgnoreError
Function calls should NOT save the errno/last error after the call. This option can be overridden on individual methods by use of theSaveError
annotation.- See Also:
-
TypeMapper
A type mapper which maps java types to native types is present. -
FunctionMapper
A function mapper which maps from java function names to native function names. -
CallingConvention
The type of calling convention.- See Also:
-
LoadNow
Load the library into memory immediately, instead of lazily loading it -
PreferCustomPaths
Relevant for GNU/LinuxPlatform.Linux
only Prefer custom paths over system paths when loading a library, even if the custom path has a lower version. By default JNR-FFI will choose the library of the desired name with the highest version, whether in the custom paths or the system default paths. This can be a problem if you are distributing your own library for examplelibfoo.so
and the system paths happen to have alibfoo.so.4
for example, in which case JNR-FFI will prefer the higher version despite your explicit custom paths. By using this option, JNR-FFI will know to prefer the custom paths, even if they have a lower version, this ensures consistent behaviors across environments.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-