Modifier and Type	Class and Description
public static interface	Structure.ByReference Tagging interface to indicate the address of an instance of the Structure type is to be used within a `Structure` definition rather than nesting the full Structure contents.
public static interface	Structure.ByValue Tagging interface to indicate the value of an instance of the `Structure` type is to be used in function invocations rather than its address.
private static class	Structure.FFIType This class auto-generates an ffi_type structure appropriate for a given structure for use by libffi.
private static class	Structure.MemberOrder
pack-priv class	Structure.StructField

Modifier and Type	Field and Description
public static final int	ALIGN_DEFAULT Use the platform default alignment.
public static final int	ALIGN_GNUC validated for 32-bit x86 linux/gcc; align field size, max 4 bytes
public static final int	ALIGN_MSVC validated for w32/msvc; align on field size
public static final int	ALIGN_NONE No alignment, place all fields on nearest 1-byte boundary
private int	alignType
protected static final int	CALCULATE_SIZE
pack-priv static final boolean	isPPC
pack-priv static final boolean	isSPARC
private static final int	MAX_GNUC_ALIGNMENT
private Pointer	memory
private Map<K, V>	nativeStrings
private static Set<E>	reading
private static final boolean	REVERSE_FIELDS
private int	size
private int	structAlignment
private Map<K, V>	structFields
private long	typeInfo
private TypeMapper	typeMapper

Access	Constructor and Description
protected	Structure()
protected	Structure(int size)
protected	Structure(int size, int alignment)

Method Summary

Modifier and Type	Method and Description
protected void	allocateMemory() Attempt to allocate memory if sufficient information is available.
protected void	allocateMemory(int size) Provided for derived classes to indicate a different size than the default.
pack-priv int	calculateAlignedSize(int calculatedSize)
pack-priv int	calculateSize(boolean force) Calculate the amount of native memory required for this structure.
public void	clear()
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. This structure is only equal to another based on the same native memory address and data type.
pack-priv Map<K, V>	fields() Return all fields in this structure (ordered).
private String	format(Class<T> type)
pack-priv Object	getField(Structure.StructField structField) Obtain the value currently in the Java field.
protected int	getNativeAlignment(Class<T> type, Object value, boolean isFirstElement) Overridable in subclasses.
private static int	getNativeSize(Class<T> type, Object value) Returns the native size of the given class, in bytes.
public Pointer	getPointer() Return a `Pointer` object to this structure.
protected int	getStructAlignment()
pack-priv Pointer	getTypeInfo() Obtain native type information for this structure.
pack-priv static Pointer	getTypeInfo(Object obj) Exposed for testing purposes only.
public int	hashCode() Overrides java.lang.Object.hashCode. Since `equals` depends on the native address, use that as the hash code.
public static Structure	Returns: the new instance newInstance(Class<T> type) Create a new Structure instance of the given type
public void	read() Reads the fields of the struct from native memory
public Object	Returns: the new field value, after updating readField(String name) Force a read of the given field from native memory.
pack-priv Object	readField(Structure.StructField structField) Read the given field and return its value.
protected void	setAlignType(int alignType) Change the alignment of this structure.
private void	setField(Structure.StructField structField, Object value)
protected void	setTypeMapper(TypeMapper mapper) Change the type mapping for this structure.
public int	size()
public Structure[]	toArray(Structure[] array) Returns a view of this structure's memory as an array of structures.
public Structure[]	toArray(int size) Returns a view of this structure's memory as an array of structures.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private String	toString(int indent)
pack-priv static Structure	Returns: Updated `Structure.ByReference` object updateStructureByReference(Class<T> Structure subclass type, Structure Original Structure object s, Pointer the native `struct *` address) Only keep the original structure if its address is unchanged.
protected void	useMemory(Pointer m) Set the memory used by this structure.
protected void	useMemory(Pointer m, int offset) Set the memory used by this structure.
public void	write() Writes the fields of the struct to native memory
public void	writeField(String name) Write the given field to native memory.
pack-priv void	writeField(Structure.StructField structField)

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

Field Detail

ALIGN_DEFAULT	back to summary
public static final int ALIGN_DEFAULT Use the platform default alignment.

ALIGN_GNUC	back to summary
public static final int ALIGN_GNUC validated for 32-bit x86 linux/gcc; align field size, max 4 bytes

ALIGN_MSVC	back to summary
public static final int ALIGN_MSVC validated for w32/msvc; align on field size

ALIGN_NONE	back to summary
public static final int ALIGN_NONE No alignment, place all fields on nearest 1-byte boundary

alignType	back to summary
private int alignType

CALCULATE_SIZE	back to summary
protected static final int CALCULATE_SIZE

isPPC	back to summary
pack-priv static final boolean isPPC

isSPARC	back to summary
pack-priv static final boolean isSPARC

MAX_GNUC_ALIGNMENT	back to summary
private static final int MAX_GNUC_ALIGNMENT

memory	back to summary
private Pointer memory

nativeStrings	back to summary
private Map<K, V> nativeStrings

reading	back to summary
private static Set<E> reading

REVERSE_FIELDS	back to summary
private static final boolean REVERSE_FIELDS

size	back to summary
private int size

structAlignment	back to summary
private int structAlignment

structFields	back to summary
private Map<K, V> structFields

typeInfo	back to summary
private long typeInfo

typeMapper	back to summary
private TypeMapper typeMapper

Constructor Detail

Structure	back to summary
protected Structure()

Structure	back to summary
protected Structure(int size)

Structure	back to summary
protected Structure(int size, int alignment)

Method Detail

allocateMemory	back to summary
protected void allocateMemory() Attempt to allocate memory if sufficient information is available. Returns whether the operation was successful.

allocateMemory	back to summary
protected void allocateMemory(int size) Provided for derived classes to indicate a different size than the default. Returns whether the operation was successful.

calculateAlignedSize	back to summary
pack-priv int calculateAlignedSize(int calculatedSize)

calculateSize back to summary

calculateSize	back to summary
pack-priv int calculateSize(boolean force) Calculate the amount of native memory required for this structure. May return `CALCULATE_SIZE` if the size can not yet be determined (usually due to fields in the derived class not yet being initialized). If the `force` parameter is `true` will throw an `IllegalStateException` if the size can not be determined. Exceptions IllegalStateException: an array field is not initialized IllegalArgumentException: when an unsupported field type is encountered

pack-priv int calculateSize(boolean force)

Calculate the amount of native memory required for this structure. May return CALCULATE_SIZE if the size can not yet be determined (usually due to fields in the derived class not yet being initialized).

If the force parameter is true will throw an IllegalStateException if the size can not be determined.

Exceptions

IllegalStateException:: an array field is not initialized
IllegalArgumentException:: when an unsupported field type is encountered

clear	back to summary
public void clear()

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. This structure is only equal to another based on the same native memory address and data type. Parameters o:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

This structure is only equal to another based on the same native memory address and data type.

Parameters

o:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

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

fields	back to summary
pack-priv Map<K, V> fields() Return all fields in this structure (ordered).

format	back to summary
private String format(Class<T> type)

getField	back to summary
pack-priv Object getField(Structure.StructField structField) Obtain the value currently in the Java field. Does not read from memory.

getNativeAlignment	back to summary
protected int getNativeAlignment(Class<T> type, Object value, boolean isFirstElement) Overridable in subclasses.

getNativeSize	back to summary
private static int getNativeSize(Class<T> type, Object value) Returns the native size of the given class, in bytes.

getPointer	back to summary
public Pointer getPointer() Return a `Pointer` object to this structure. Note that if you use the structure's pointer as a function argument, you are responsible for calling `write()` prior to the call and `read()` after the call. These calls are normally handled automatically by the `Function` object when it encounters a `Structure` argument or return value.

getStructAlignment	back to summary
protected int getStructAlignment()

getTypeInfo	back to summary
pack-priv Pointer getTypeInfo() Obtain native type information for this structure.

getTypeInfo	back to summary
pack-priv static Pointer getTypeInfo(Object obj) Exposed for testing purposes only.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Since `equals` depends on the native address, use that as the hash code. Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object.

public int hashCode()

Overrides java.lang.Object.hashCode.

Since equals depends on the native address, use that as the hash code.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object.

newInstance	back to summary
public static Structure newInstance(Class<T> type) throws IllegalArgumentException Create a new Structure instance of the given type Returns:Structure the new instance Exceptions IllegalArgumentException: if the instantiation fails

newInstance

back to summary

public static Structure newInstance(Class<T> type) throws IllegalArgumentException

Create a new Structure instance of the given type

Returns:Structure

the new instance

Exceptions

IllegalArgumentException:: if the instantiation fails

read	back to summary
public void read() Reads the fields of the struct from native memory

readField	back to summary
public Object readField(String name) Force a read of the given field from native memory. Returns:Object the new field value, after updating Exceptions IllegalArgumentException: if no field exists with the given name

readField

back to summary

public Object readField(String name)

Force a read of the given field from native memory.

Returns:Object

the new field value, after updating

Exceptions

IllegalArgumentException:: if no field exists with the given name

readField	back to summary
pack-priv Object readField(Structure.StructField structField) Read the given field and return its value.

setAlignType	back to summary
protected void setAlignType(int alignType) Change the alignment of this structure. Re-allocates memory if necessary. If alignment is `ALIGN_DEFAULT`, the default alignment for the defining class will be used.

setField	back to summary
private void setField(Structure.StructField structField, Object value)

setTypeMapper	back to summary
protected void setTypeMapper(TypeMapper mapper) Change the type mapping for this structure. May cause the structure to be resized and any existing memory to be reallocated. If `null`, the default mapper for the defining class will be used.

size	back to summary
public int size()

toArray	back to summary
public Structure[] toArray(Structure[] array) Returns a view of this structure's memory as an array of structures. Note that this `Structure` must have a public, no-arg constructor. If the structure is currently using a `Memory` backing, the memory will be resized to fit the entire array.

toArray	back to summary
public Structure[] toArray(int size) Returns a view of this structure's memory as an array of structures. Note that this `Structure` must have a public, no-arg constructor. If the structure is currently using a `Memory` backing, the memory will be resized to fit the entire array.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object.

toString	back to summary
private String toString(int indent)

updateStructureByReference back to summary

pack-priv static Structure updateStructureByReference(Class<T> type, Structure s, Pointer address)

Only keep the original structure if its address is unchanged. Otherwise replace it with a new object.

Parameters

type:Class<T>: Structure subclass
s:Structure: Original Structure object
address:Pointer: the native struct *

Returns:Structure

Updated Structure.ByReference object

useMemory	back to summary
protected void useMemory(Pointer m) Set the memory used by this structure. This method is used to indicate the given structure is nested within another or otherwise overlaid on some other memory block and thus does not own its own memory.

useMemory	back to summary
protected void useMemory(Pointer m, int offset) Set the memory used by this structure. This method is used to indicate the given structure is nested within another or otherwise overlaid on some other memory block and thus does not own its own memory.

write	back to summary
public void write() Writes the fields of the struct to native memory

writeField	back to summary
public void writeField(String name) Write the given field to native memory.

writeField	back to summary
pack-priv void writeField(Structure.StructField structField)

com.sun.jna back to summary

public Interface Structure.ByReference

Tagging interface to indicate the address of an instance of the Structure type is to be used within a Structure definition rather than nesting the full Structure contents. The default behavior is to inline Structure fields.

com.sun.jna back to summary

public Interface Structure.ByValue

Tagging interface to indicate the value of an instance of the Structure type is to be used in function invocations rather than its address. The default behavior is to treat Structure function parameters and return values as by reference, meaning the address of the structure is used.

com.sun.jna back to summary

private Class Structure.FFIType

Class Inheritance

extends Structure

java.lang.Object
com.sun.jna.Structure
com.sun.jna.Structure.FFIType

This class auto-generates an ffi_type structure appropriate for a given structure for use by libffi. The lifecycle of this structure is easier to manage on the Java side than in native code.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Structure.FFIType.FFITypes
public static class	Structure.FFIType.size_t

Field Summary

Modifier and Type	Field and Description
public short	alignment
public Pointer	elements
private static final int	FFI_TYPE_STRUCT
public Structure.FFIType.size_t	size Hides com.sun.jna.Structure.size.
public short	type
private static Map<K, V>	typeInfoMap

Inherited from com.sun.jna.Structure:: ALIGN_DEFAULT ALIGN_GNUC ALIGN_MSVC ALIGN_NONE CALCULATE_SIZE isPPC isSPARC

Constructor Summary

Access	Constructor and Description
private	FFIType(Structure ref)
private	FFIType(Object array, Class<T> type)

Method Summary

Modifier and Type	Method and Description
pack-priv static Pointer	get(Object obj)
private static Pointer	get(Object obj, Class<T> cls)
private void	init(Pointer[] els)

Field Detail

alignment	back to summary
public short alignment

elements	back to summary
public Pointer elements

FFI_TYPE_STRUCT	back to summary
private static final int FFI_TYPE_STRUCT

size	back to summary
public Structure.FFIType.size_t size Hides com.sun.jna.Structure.size.

type	back to summary
public short type

typeInfoMap	back to summary
private static Map<K, V> typeInfoMap

Constructor Detail

FFIType	back to summary
private FFIType(Structure ref)

FFIType	back to summary
private FFIType(Object array, Class<T> type)

Method Detail

get	back to summary
pack-priv static Pointer get(Object obj)

get	back to summary
private static Pointer get(Object obj, Class<T> cls)

init	back to summary
private void init(Pointer[] els)

com.sun.jna back to summary

private Class Structure.FFIType.FFITypes

Class Inheritance

extends Object

java.lang.Object
com.sun.jna.Structure.FFIType.FFITypes

Field Summary

Modifier and Type	Field and Description
private static Pointer	ffi_type_double
private static Pointer	ffi_type_float
private static Pointer	ffi_type_longdouble
private static Pointer	ffi_type_pointer
private static Pointer	ffi_type_sint16
private static Pointer	ffi_type_sint32
private static Pointer	ffi_type_sint64
private static Pointer	ffi_type_sint8
private static Pointer	ffi_type_uint16
private static Pointer	ffi_type_uint32
private static Pointer	ffi_type_uint64
private static Pointer	ffi_type_uint8
private static Pointer	ffi_type_void

Constructor Summary

Access	Constructor and Description
private	FFITypes()

Method Summary

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

Field Detail

ffi_type_double	back to summary
private static Pointer ffi_type_double

ffi_type_float	back to summary
private static Pointer ffi_type_float

ffi_type_longdouble	back to summary
private static Pointer ffi_type_longdouble

ffi_type_pointer	back to summary
private static Pointer ffi_type_pointer

ffi_type_sint16	back to summary
private static Pointer ffi_type_sint16

ffi_type_sint32	back to summary
private static Pointer ffi_type_sint32

ffi_type_sint64	back to summary
private static Pointer ffi_type_sint64

ffi_type_sint8	back to summary
private static Pointer ffi_type_sint8

ffi_type_uint16	back to summary
private static Pointer ffi_type_uint16

ffi_type_uint32	back to summary
private static Pointer ffi_type_uint32

ffi_type_uint64	back to summary
private static Pointer ffi_type_uint64

ffi_type_uint8	back to summary
private static Pointer ffi_type_uint8

ffi_type_void	back to summary
private static Pointer ffi_type_void

Constructor Detail

FFITypes	back to summary
private FFITypes()

com.sun.jna back to summary

public Class Structure.FFIType.size_t

Class Inheritance

extends IntegerType

java.lang.Object
java.lang.Number
com.sun.jna.IntegerType
com.sun.jna.Structure.FFIType.size_t

Constructor Summary

Access	Constructor and Description
public	size_t()
public	size_t(long value)

Method Summary

Inherited from com.sun.jna.IntegerType:: doubleValue equals floatValue fromNative hashCode intValue longValue nativeType setValue toNative toString

Constructor Detail

size_t	back to summary
public size_t()

size_t	back to summary
public size_t(long value)

public abstract Class Structure

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface Structure.ByReference

public Interface Structure.ByValue

private Class Structure.FFIType

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Structure.FFIType.FFITypes

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public Class Structure.FFIType.size_t

Constructor Summary

Method Summary

Constructor Detail

private Class Structure.MemberOrder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

pack-priv Class Structure.StructField

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Modifier and Type	Field and Description
public FromNativeContext	context
public Field	field
public boolean	isVolatile
public String	name
public int	offset
public FromNativeConverter	readConverter
public int	size
public Class<T>	type
public ToNativeConverter	writeConverter