Modifier and Type	Class and Description
pack-priv static class	Type.Builtin Types that are built-in to libffi.
pack-priv static class	Type.TypeInfo This is a lazy loaded cache of builtin type info, so we can still have Type.VOID as a public static variable without it causing the native library to load.

Field Summary

Modifier and Type	Field and Description
private int	alignment
public static final Type	DOUBLE The native double type
public static final Type	FLOAT The native float type
private volatile long	handle
public static final Type	LONGDOUBLE The native long double type
public static final Type	POINTER The native memory address type
public static final Type	SCHAR The native signed char type
public static final Type	SINT The native signed integer type
public static final Type	SINT16 The native signed 16 bit integer type
public static final Type	SINT32 The native signed 32 bit integer type
public static final Type	SINT64 The native signed 64 bit integer type
public static final Type	SINT8 The native signed 8 bit integer type
private int	size
public static final Type	SLONG The native signed long integer type
public static final Type	SLONG_LONG The native signed long long integer type
public static final Type	SSHORT The native signed short integer type
private int	type
public static final Type	UCHAR The native unsigned char type
public static final Type	UINT The native unsigned integer type
public static final Type	UINT16 The native unsigned 16 bit integer type
public static final Type	UINT32 The native unsigned 32 bit integer type
public static final Type	UINT64 The native unsigned 64 bit integer type
public static final Type	UINT8 The native unsigned 8 bit integer type
public static final Type	ULONG The native unsigned long integer type
public static final Type	ULONG_LONG The native unsigned long long integer type
public static final Type	USHORT The native unsigned short integer type
public static final Type	VOID The native void type

Constructor Summary

Access	Constructor and Description
public	Type()

Method Summary

Modifier and Type	Method and Description
public final int	Returns: The alignment of this type, in bytes. alignment() Gets the alignment of this type.
private static Type	Returns: A `Type` instance. builtin(NativeType The builtin type enum. nativeType) Creates a `Type` instance for builtin types.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
pack-priv abstract Type.TypeInfo	getTypeInfo()
pack-priv final long	Returns: The address of the ffi_type structure handle() Gets the native address of the ffi_type struct for this `Type`
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
pack-priv static long[]	Returns: An array of native ffi_type handles. nativeHandles(Type[] An array of `Type` objects types) Converts an array of `Type` objects into an array of pointers to ffi_type structures.
pack-priv static long[]	Returns: An array of native ffi_type handles. nativeHandles(List<Type> A list of `Type` objects types) Converts a list of `Type` objects into an array of pointers to ffi_type structures.
private int	resolveAlignment()
private long	resolveHandle()
private int	resolveSize()
private int	resolveType()
public final int	Returns: The size of this type, in bytes. size() Gets the size of this type.
public final int	Returns: An integer representing the FFI type. type() Gets the FFI type enum value for this `Type`

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

Field Detail

alignment	back to summary
private int alignment

DOUBLE	back to summary
public static final Type DOUBLE The native double type

FLOAT	back to summary
public static final Type FLOAT The native float type

handle	back to summary
private volatile long handle

LONGDOUBLE	back to summary
public static final Type LONGDOUBLE The native long double type

POINTER	back to summary
public static final Type POINTER The native memory address type

SCHAR	back to summary
public static final Type SCHAR The native signed char type

SINT	back to summary
public static final Type SINT The native signed integer type

SINT16	back to summary
public static final Type SINT16 The native signed 16 bit integer type

SINT32	back to summary
public static final Type SINT32 The native signed 32 bit integer type

SINT64	back to summary
public static final Type SINT64 The native signed 64 bit integer type

SINT8	back to summary
public static final Type SINT8 The native signed 8 bit integer type

size	back to summary
private int size

SLONG	back to summary
public static final Type SLONG The native signed long integer type

SLONG_LONG	back to summary
public static final Type SLONG_LONG The native signed long long integer type

SSHORT	back to summary
public static final Type SSHORT The native signed short integer type

type	back to summary
private int type

UCHAR	back to summary
public static final Type UCHAR The native unsigned char type

UINT	back to summary
public static final Type UINT The native unsigned integer type

UINT16	back to summary
public static final Type UINT16 The native unsigned 16 bit integer type

UINT32	back to summary
public static final Type UINT32 The native unsigned 32 bit integer type

UINT64	back to summary
public static final Type UINT64 The native unsigned 64 bit integer type

UINT8	back to summary
public static final Type UINT8 The native unsigned 8 bit integer type

ULONG	back to summary
public static final Type ULONG The native unsigned long integer type

ULONG_LONG	back to summary
public static final Type ULONG_LONG The native unsigned long long integer type

USHORT	back to summary
public static final Type USHORT The native unsigned short integer type

VOID	back to summary
public static final Type VOID The native void type

Constructor Detail

Type	back to summary
public Type()

Method Detail

alignment	back to summary
public final int alignment() Gets the alignment of this type. Returns:int The alignment of this type, in bytes.

alignment

back to summary

public final int alignment()

Gets the alignment of this type.

Returns:int: The alignment of this type, in bytes.

builtin back to summary

builtin	back to summary
private static Type builtin(NativeType nativeType) Creates a `Type` instance for builtin types. Parameters nativeType:NativeType The builtin type enum. Returns:Type A `Type` instance.

private static Type builtin(NativeType nativeType)

Creates a Type instance for builtin types.

Parameters

nativeType:NativeType: The builtin type enum.

Returns:Type

A Type instance.

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getTypeInfo	back to summary
pack-priv abstract Type.TypeInfo getTypeInfo()

handle back to summary

handle	back to summary
pack-priv final long handle() Gets the native address of the ffi_type struct for this `Type` Returns:long The address of the ffi_type structure

pack-priv final long handle()

Gets the native address of the ffi_type struct for this Type

Returns:long: The address of the ffi_type structure

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

nativeHandles back to summary

nativeHandles	back to summary
pack-priv static long[] nativeHandles(Type[] types) Converts an array of `Type` objects into an array of pointers to ffi_type structures. Parameters types:Type[] An array of `Type` objects Returns:long[] An array of native ffi_type handles.

pack-priv static long[] nativeHandles(Type[] types)

Converts an array of Type objects into an array of pointers to ffi_type structures.

Parameters

types:Type[]: An array of Type objects

Returns:long[]

An array of native ffi_type handles.

nativeHandles back to summary

nativeHandles	back to summary
pack-priv static long[] nativeHandles(List<Type> types) Converts a list of `Type` objects into an array of pointers to ffi_type structures. Parameters types:List<Type> A list of `Type` objects Returns:long[] An array of native ffi_type handles.

pack-priv static long[] nativeHandles(List<Type> types)

Converts a list of Type objects into an array of pointers to ffi_type structures.

Parameters

types:List<Type>: A list of Type objects

Returns:long[]

An array of native ffi_type handles.

resolveAlignment	back to summary
private int resolveAlignment()

resolveHandle	back to summary
private long resolveHandle()

resolveSize	back to summary
private int resolveSize()

resolveType	back to summary
private int resolveType()

size	back to summary
public final int size() Gets the size of this type. Returns:int The size of this type, in bytes.

size

back to summary

public final int size()

Gets the size of this type.

Returns:int: The size of this type, in bytes.

type back to summary

type	back to summary
public final int type() Gets the FFI type enum value for this `Type` Returns:int An integer representing the FFI type.

public final int type()

Gets the FFI type enum value for this Type

Returns:int: An integer representing the FFI type.

com.kenai.jffi back to summary

pack-priv final Class Type.Builtin

Class Inheritance

extends Type

java.lang.Object
com.kenai.jffi.Type
com.kenai.jffi.Type.Builtin

Types that are built-in to libffi.

Field Summary

Modifier and Type	Field and Description
private final NativeType	nativeType
private Type.TypeInfo	typeInfo

Inherited from com.kenai.jffi.Type:: DOUBLE FLOAT LONGDOUBLE POINTER SCHAR SINT SINT16 SINT32 SINT64 SINT8 SLONG SLONG_LONG SSHORT UCHAR UINT UINT16 UINT32 UINT64 UINT8 ULONG ULONG_LONG USHORT VOID

Constructor Summary

Access	Constructor and Description
private	Builtin(NativeType nativeType)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides com.kenai.jffi.Type.equals. Indicates whether some other object is "equal to" this one.
pack-priv Type.TypeInfo	getTypeInfo() Implements abstract com.kenai.jffi.Type.getTypeInfo.
public int	hashCode() Overrides com.kenai.jffi.Type.hashCode. Returns a hash code value for the object.
private Type.TypeInfo	lookupTypeInfo()

Inherited from com.kenai.jffi.Type:: alignment handle nativeHandles nativeHandles size type

Field Detail

nativeType	back to summary
private final NativeType nativeType

typeInfo	back to summary
private Type.TypeInfo typeInfo

Constructor Detail

Builtin	back to summary
private Builtin(NativeType nativeType)

Method Detail

equals back to summary

public boolean equals(Object o)

Overrides com.kenai.jffi.Type.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getTypeInfo	back to summary
pack-priv Type.TypeInfo getTypeInfo() Implements abstract com.kenai.jffi.Type.getTypeInfo.

hashCode back to summary

public int hashCode()

Overrides com.kenai.jffi.Type.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

lookupTypeInfo	back to summary
private Type.TypeInfo lookupTypeInfo()

Modifier and Type	Field and Description
pack-priv final int	alignment The minimum alignment of this type
pack-priv final long	handle The address of this type's ffi_type structure
pack-priv final int	size The size in bytes of this type
pack-priv final int	type The FFI type of this type

public abstract Class Type

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class Type.Builtin

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class Type.TypeInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail