Structure (J2Native API Documentation)

com.smardec

j2native

AnsiString

FunctionExecutionException

FunctionNotFoundException

IllegalMemoryAccessException

LibraryNotFoundException

com.smardec.j2native
Class Structure

java.lang.Object
|
+--com.smardec.j2native.Argument
|
+--com.smardec.j2native.Structure

All Implemented Interfaces:: java.lang.Cloneable

public abstract class Structure
extends Argument

The Structure class represents structures in tems of C language. Structure is a superclass for classes representing specific structures.
Example of usage:

 final public class RECT extends Structure{
   public UInt32 left;
   public UInt32 top;
   public UInt32 right;
   public UInt32 bottom;
 
   public RECT(){
     left = new UInt32();
     top = new UInt32();
     right = new UInt32();
     bottom = new UInt32();
     initialize(new Argument[]{left, top, right, bottom});
   }
 }

You are not forced to derive another class from Struct. A needed structure can be constructed using constructor taking array of Arguments.

Field Summary

Fields inherited from class com.smardec.j2native.Argument

JAVA_SIDE, NATIVE_SIDE

Constructor Summary

Structure()
Constructs a new structure.

Structure(Argument[] members)
Constructs a new structure that consists of a given set of members with default alignment.

Structure(Argument[] members, int align)
Constructs a new structure that consists of a given set of members with specified alignment.

Method Summary

void free()
To avoid memory leaks in native memory should be used this method.

void fromBytesValue(byte[] bytes, int offset)
Restores itself from provided array of bytes.

int getLength()
Returns length in bytes.

Argument[] getMembers()
Returns structure members.

protected void initialize(Argument[] members)
Initializes the Structureinstance with specified structure members.

protected boolean isFixedLength()
Identify if Argument is a fixed length variable.

protected void read(long handle, int offset)
Reads itself from the memory.

protected void readFromStack(byte[] stack, int offset)
Read itself from stack.

byte[] toBytesValue()
Encodes itself and returns it's representation as array of bytes.

protected void toBytesValue(byte[] bytes, int offset)
Encodes itself to the provided array of bytes.

protected void update(byte side)
This method is used to synchronize Java side and native part.

protected void write(long handle, int offset)
Writes itself to the memory.

protected void writeToStack(byte[] stack, int offset)
Writes itself to stack.

Methods inherited from class com.smardec.j2native.Argument

clone, finalize, getAlignedLength, getResultFlags, readFromRAM, restoreFromRAM, storeToRAM, writeToRAM

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Structure
public Structure()

Constructs a new structure. Initial contents are undefined. When using this constructor, subclass should then call the initialize() method to define structure members and alignment

Structure
public Structure(Argument[] members)

Constructs a new structure that consists of a given set of members with default alignment.
Parameters:: members - structure members as appear in structure definition

Structure
public Structure(Argument[] members, int align)

Constructs a new structure that consists of a given set of members with specified alignment. NOTE: Alignment should be 1 for Delphi packed record
Parameters:: members - structure members as appear in structure definition; align - alignment in bytes

Method Detail

initialize
protected void initialize(Argument[] members)

Initializes the Structureinstance with specified structure members.