com.ochafik.lang.jnaerator.runtime
Class Structure<S extends Structure<S,V,R>,V extends S,R extends S>

java.lang.Object
  com.sun.jna.Structure
      com.ochafik.lang.jnaerator.runtime.Structure<S,V,R>

All Implemented Interfaces:

StructureType, StructureTypeDependent, Comparable<Structure<S,V,R>>

Direct Known Subclasses:

StringPointer, WStringPointer

public abstract class Structure<S extends Structure<S,V,R>,V extends S,R extends S>
extends Structure
implements Comparable<Structure<S,V,R>>, StructureType, StructureTypeDependent

Nested Class Summary

static interface	Structure.ByReference
static interface	Structure.ByValue

Field Summary

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Structure()

Method Summary

R	byReference()
V	byValue()
S[]	castToArray()
S[]	castToArray(int size)
S[]	castToArray(Structure[] array)
R[]	castToReferenceArray()
R[]	castToReferenceArray(int size)
V[]	castToValueArray()
V[]	castToValueArray(int size)
S	clone()
int	compareTo(Structure<S,V,R> o) Simply does a memcmp between the two memory blocks of the two structures
protected Integer	getBitsAnnotation(Field field) Override this in a subclass to support bit fields (@link http://en.wikipedia.org/wiki/C_syntax#Bit_fields) : package com.sun.jna; import java.lang.annotation
static <S extends Structure> S[]	newArray(Class<S> structClass, int arrayLength)
protected abstract R	newByReference()
protected abstract V	newByValue()
protected abstract S	newInstance()
void	read() Reads the fields of the struct from native memory
protected void	readDependency()
void	setDependency(StructureType type)
protected <T extends Union<?,?,?>> T	setupClone(T clone)
protected <T extends Structure<S,V,R>> T	setupClone(T clone, StructureType dependency)
S[]	toArray() Deprecated. use castToArray instead
S[]	toArray(int size) Deprecated. use castToArray instead
S[]	toArray(Structure[] array) Deprecated. use castToArray instead
R[]	toReferenceArray() Deprecated. use castToArray instead
R[]	toReferenceArray(int size) Deprecated. use castToArray instead
V[]	toValueArray() Deprecated. use castToArray instead
V[]	toValueArray(int size) Deprecated. use castToArray instead
S	use(Buffer m)
S	use(Buffer b, long byteOffset)
S	use(Pointer m)
S	use(Pointer m, long byteOffset)
void	write() Writes the fields of the struct to native memory

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, clear, ensureAllocated, equals, getAutoRead, getAutoWrite, getFieldOrder, getNativeAlignment, getPointer, getStructAlignment, hashCode, newInstance, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setFieldOrder, setTypeMapper, size, sortFields, toString, useMemory, useMemory, writeField, writeField

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ochafik.lang.jnaerator.runtime.StructureType

getPointer, size

Constructor Detail

Structure

public Structure()

Method Detail

setDependency

public void setDependency(StructureType type)

Specified by:

setDependency in interface StructureTypeDependent

readDependency

protected void readDependency()

read

public void read()

Description copied from class: Structure

Reads the fields of the struct from native memory

Specified by:

read in interface StructureType

Overrides:

read in class Structure

write

public void write()

Description copied from class: Structure

Writes the fields of the struct to native memory

Specified by:

write in interface StructureType

Overrides:

write in class Structure

setupClone

protected <T extends Structure<S,V,R>> T setupClone(T clone,
                                                    StructureType dependency)

newInstance

protected abstract S newInstance()

newByValue

protected abstract V newByValue()

newByReference

protected abstract R newByReference()

byReference

public R byReference()

byValue

public V byValue()

clone

public S clone()

Overrides:

clone in class Object

newArray

public static <S extends Structure> S[] newArray(Class<S> structClass,
                                                 int arrayLength)

toArray

@Deprecated
public S[] toArray(int size)

Deprecated. use castToArray instead

Description copied from class: Structure

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 auto-allocated Memory backing, the memory will be resized to fit the entire array.

Overrides:

toArray in class Structure

toArray

@Deprecated
public S[] toArray()

Deprecated. use castToArray instead

toReferenceArray

@Deprecated
public R[] toReferenceArray(int size)

Deprecated. use castToArray instead

toValueArray

@Deprecated
public V[] toValueArray(int size)

Deprecated. use castToArray instead

toReferenceArray

@Deprecated
public R[] toReferenceArray()

Deprecated. use castToArray instead

toValueArray

@Deprecated
public V[] toValueArray()

Deprecated. use castToArray instead

toArray

@Deprecated
public S[] toArray(Structure[] array)

Deprecated. use castToArray instead

Description copied from class: Structure

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 auto-allocated Memory backing, the memory will be resized to fit the entire array.

Overrides:

toArray in class Structure

castToArray

public S[] castToArray(int size)

castToArray

public S[] castToArray()

castToReferenceArray

public R[] castToReferenceArray(int size)

castToValueArray

public V[] castToValueArray(int size)

castToReferenceArray

public R[] castToReferenceArray()

castToValueArray

public V[] castToValueArray()

castToArray

public S[] castToArray(Structure[] array)

getBitsAnnotation

protected Integer getBitsAnnotation(Field field)

Description copied from class: Structure

Override this in a subclass to support bit fields (@link http://en.wikipedia.org/wiki/C_syntax#Bit_fields) : package com.sun.jna; import java.lang.annotation.*;

Overrides:

getBitsAnnotation in class Structure

compareTo

public int compareTo(Structure<S,V,R> o)

Simply does a memcmp between the two memory blocks of the two structures

Specified by:

compareTo in interface Comparable<Structure<S extends Structure<S,V,R>,V extends S,R extends S>>

setupClone

protected <T extends Union<?,?,?>> T setupClone(T clone)

use

public S use(Pointer m)

Specified by:

use in interface StructureType

use

public S use(Pointer m,
             long byteOffset)

use

public S use(Buffer m)

use

public S use(Buffer b,
             long byteOffset)