Top Fields Constructors Methods

jnr.ffi.provider

public final Class ParameterFlags

Class Inheritance

extends Object

java.lang.Object
jnr.ffi.provider.ParameterFlags

Imports

jnr.ffi.annotations.Direct, .In, .NulTerminate, .Out, .Pinned, .Transient, java.lang.annotation.Annotation, java.util.Collection

Field Summary

Modifier and Type	Field and Description
public static final int	DIRECT When allocating memory for the parameter, allocate a persistent memory block
public static final int	IN Contents of the parameter memory will be copied from from java to native memory
public static final int	NULTERMINATE The contents of the java array should have a zero byte appended
public static final int	OUT Contents of the parameter memory will be copied from native memory back to java
public static final int	PINNED The java array memory should be pinned by the JVM during the function call
public static final int	TRANSIENT When allocating memory for the parameter, a temporary memory block can be used

Constructor Summary

Access	Constructor and Description
private	ParameterFlags()

Method Summary

Modifier and Type	Method and Description
public static boolean	isDirect(int flags)
public static boolean	Returns: `true` if the annotation is a parameter flag isFlag(Annotation the annotation to check. annotation) Checks if the annotation is a recognised parameter flag.
public static boolean	isIn(int flags)
public static boolean	isNulTerminate(int flags)
public static boolean	isOut(int flags)
public static boolean	isPinned(int flags)
public static boolean	isTransient(int flags)
public static int	parse(Annotation annotation)
public static int	parse(Annotation[] annotations)
public static int	parse(Collection<Annotation> annotations)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DIRECT	back to summary
public static final int DIRECT When allocating memory for the parameter, allocate a persistent memory block

IN	back to summary
public static final int IN Contents of the parameter memory will be copied from from java to native memory

NULTERMINATE	back to summary
public static final int NULTERMINATE The contents of the java array should have a zero byte appended

OUT	back to summary
public static final int OUT Contents of the parameter memory will be copied from native memory back to java

PINNED	back to summary
public static final int PINNED The java array memory should be pinned by the JVM during the function call

TRANSIENT	back to summary
public static final int TRANSIENT When allocating memory for the parameter, a temporary memory block can be used

Constructor Detail

ParameterFlags	back to summary
private ParameterFlags()

Method Detail

isDirect	back to summary
public static boolean isDirect(int flags)

isFlag back to summary

public static boolean isFlag(Annotation annotation)

Checks if the annotation is a recognised parameter flag.

Parameters

annotation:Annotation: the annotation to check.

Returns:boolean

true if the annotation is a parameter flag

isIn	back to summary
public static boolean isIn(int flags)

isNulTerminate	back to summary
public static boolean isNulTerminate(int flags)

isOut	back to summary
public static boolean isOut(int flags)

isPinned	back to summary
public static boolean isPinned(int flags)

isTransient	back to summary
public static boolean isTransient(int flags)

parse	back to summary
public static int parse(Annotation annotation)

parse	back to summary
public static int parse(Annotation[] annotations)

parse	back to summary
public static int parse(Collection<Annotation> annotations)