Module org.jnrproject.ffi

Package jnr.ffi

Enum Class LibraryOption

java.lang.Object

java.lang.Enum<LibraryOption>

jnr.ffi.LibraryOption

All Implemented Interfaces:

Serializable, Comparable<LibraryOption>, Constable

public enum LibraryOption
extends Enum<LibraryOption>

Options that apply to a library

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CallingConvention	The type of calling convention.
FunctionMapper	A function mapper which maps from java function names to native function names.
IgnoreError	Function calls should NOT save the errno/last error after the call.
LoadNow	Load the library into memory immediately, instead of lazily loading it
SaveError	Function calls should save the errno/last error after the call.
TypeMapper	A type mapper which maps java types to native types is present.

Method Summary

Modifier and Type	Method	Description
static LibraryOption	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LibraryOption[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SaveError

public static final LibraryOption SaveError

Function calls should save the errno/last error after the call. This option can be overridden on individual methods by use of the IgnoreError annotation.

See Also:

• LibraryLoader.saveError(Map, boolean, boolean)

IgnoreError

public static final LibraryOption IgnoreError

Function calls should NOT save the errno/last error after the call. This option can be overridden on individual methods by use of the SaveError annotation.

See Also:

• LibraryLoader.saveError(Map, boolean, boolean)

TypeMapper

public static final LibraryOption TypeMapper

A type mapper which maps java types to native types is present.

FunctionMapper

public static final LibraryOption FunctionMapper

A function mapper which maps from java function names to native function names.

CallingConvention

public static final LibraryOption CallingConvention

The type of calling convention.

See Also:

• CallingConvention

LoadNow

public static final LibraryOption LoadNow

Load the library into memory immediately, instead of lazily loading it

Method Details

values

public static LibraryOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static LibraryOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null