stec.jenie
Class StructureArray

java.lang.Object
  stec.jenie.NativeObject
      stec.jenie.NativeArray
          stec.jenie.StructureArray

public class StructureArray
extends NativeArray

Represents a native array of structures.

Arrays can only be passed or returned by functions and callbacks as a pointer to the array.

Since:

1.0.0 12/05/2004

Constructor Summary

StructureArray(int[] dimensions, Structure structure)
Constructs a new n-dimensional array of structures of the specified number of specified structures.

StructureArray(int size1, int size2, int size3, Structure structure)
Constructs a new three dimensional array of structures of the specified number of specified structures.

StructureArray(int size1, int size2, Structure structure)
Constructs a new two dimensional array of structures of the specified number of specified structures.

StructureArray(int size, Structure structure)
Constructs a new one dimensional array of structures of the specified number of specified structures.

StructureArray(Pointer pointer, int[] dimensions, Structure structure)
Constructs a new n-dimensional array of structures from the specified pointer to a n-dimensional array of structures of the specified number of structures.

StructureArray(Pointer pointer, int size1, int size2, int size3, Structure structure)
Constructs a new three dimensional array of structures from the specified pointer to a three dimensional array of structures of the specified number of structures.

StructureArray(Pointer pointer, int size1, int size2, Structure structure)
Constructs a new two dimensional array of structures from the specified pointer to a two dimensional array of structures of the specified number of structures.

StructureArray(Pointer pointer, int size, Structure structure)
Constructs a new one dimensional array of structures from the specified pointer to a one dimensional array of structures of the specified number of structures.

StructureArray(Pointer pointer, StructureArray array)
Constructs a new n-dimensional array of structures from the specified pointer to a n-dimensional array of structures with the same number of dimensions and size of each dimension as the specified n-dimensional array of structures.

StructureArray(StructureArray array)
Constructs a new n-dimensional array of structurs with the same number of dimensions, size of each dimension and structure as the specified n-dimensional array of structures.

Method Summary

java.lang.Object	clone() Returns a clone of this array of structures.
boolean	equals(java.lang.Object object) Returns whether this array of structures equals the specified object.
Structure	getValueAt(int index) Returns the structure at the specified index.
Structure	getValueAt(int[] indexes) Returns the structure at the specified index.
Structure	getValueAt(int index1, int index2) Returns the structure at the specified index.
Structure	getValueAt(int index1, int index2, int index3) Returns the structure at the specified index.
void	setValueAt(int[] indexes, Structure structure) Sets the structure at the specified index.
void	setValueAt(int index1, int index2, int index3, Structure structure) Sets the structure at the specified index.
void	setValueAt(int index1, int index2, Structure structure) Sets the structure at the specified index.
void	setValueAt(int index, Structure structure) Sets the structure at the specified index.

Methods inherited from class stec.jenie.NativeArray

getDimensions, getElementSize, getOffset, getOffset, getOffset, getOffset, i2a, i2a, i2a

Methods inherited from class stec.jenie.NativeObject

getAlignment, getNativeAddress, getNativeBuffer, getNativeBufferHandle, hashCode, setNativeBuffer, setNativeBuffer, setNativeBuffer, size

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StructureArray

public StructureArray(int size,
                      Structure structure)
               throws java.lang.OutOfMemoryError,
                      java.lang.IllegalArgumentException

Constructs a new one dimensional array of structures of the specified number of specified structures.

Parameters:

size - the number of structures in the array.

structure - the structure to use.

Throws:

java.lang.OutOfMemoryError - if there is not enough free memory.

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

StructureArray

public StructureArray(int size1,
                      int size2,
                      Structure structure)
               throws java.lang.OutOfMemoryError,
                      java.lang.IllegalArgumentException

Constructs a new two dimensional array of structures of the specified number of specified structures.

Parameters:

size1 - the size of the first dimension.

size2 - the size of the second dimension.

structure - the structure to use.

Throws:

java.lang.OutOfMemoryError - if there is not enough free memory.

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

StructureArray

public StructureArray(int size1,
                      int size2,
                      int size3,
                      Structure structure)
               throws java.lang.OutOfMemoryError,
                      java.lang.IllegalArgumentException

Constructs a new three dimensional array of structures of the specified number of specified structures.

Parameters:

size1 - the size of the first dimension.

size2 - the size of the second dimension.

size3 - the size of the third dimension.

structure - the structure to use.

Throws:

java.lang.OutOfMemoryError - if there is not enough free memory.

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

StructureArray

public StructureArray(int[] dimensions,
                      Structure structure)
               throws java.lang.OutOfMemoryError,
                      java.lang.IllegalArgumentException

Constructs a new n-dimensional array of structures of the specified number of specified structures.

Parameters:

dimensions - an array of integers representing the number of dimensions and the size of each dimension.

structure - the structure to use.

Throws:

java.lang.OutOfMemoryError - if there is not enough free memory.

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

StructureArray

public StructureArray(StructureArray array)
               throws java.lang.OutOfMemoryError,
                      java.lang.IllegalArgumentException

Constructs a new n-dimensional array of structurs with the same number of dimensions, size of each dimension and structure as the specified n-dimensional array of structures.

Parameters:

array - the n-dimensional array of structures to use.

Throws:

java.lang.OutOfMemoryError - if there is not enough free memory.

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

StructureArray

public StructureArray(Pointer pointer,
                      int size,
                      Structure structure)
               throws java.lang.IllegalArgumentException

Constructs a new one dimensional array of structures from the specified pointer to a one dimensional array of structures of the specified number of structures.

Parameters:

pointer - the pointer to the one dimensional array of structures.

size - the number of structures in the array.

structure - the structure to use.

Throws:

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

StructureArray

public StructureArray(Pointer pointer,
                      int size1,
                      int size2,
                      Structure structure)
               throws java.lang.IllegalArgumentException

Constructs a new two dimensional array of structures from the specified pointer to a two dimensional array of structures of the specified number of structures.

Parameters:

pointer - the pointer to the two dimensional array of structures.

size1 - the size of the first dimension.

size2 - the size of the second dimension.

structure - the structure to use.

Throws:

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

StructureArray

public StructureArray(Pointer pointer,
                      int size1,
                      int size2,
                      int size3,
                      Structure structure)
               throws java.lang.IllegalArgumentException

Constructs a new three dimensional array of structures from the specified pointer to a three dimensional array of structures of the specified number of structures.

Parameters:

pointer - the pointer to the three dimensional array of structures.

size1 - the size of the first dimension.

size2 - the size of the second dimension.

size3 - the size of the third dimension.

structure - the structure to use.

Throws:

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

StructureArray

public StructureArray(Pointer pointer,
                      int[] dimensions,
                      Structure structure)
               throws java.lang.IllegalArgumentException

Constructs a new n-dimensional array of structures from the specified pointer to a n-dimensional array of structures of the specified number of structures.

Parameters:

pointer - the pointer to the n-dimensional array of structures.

dimensions - an array of integers representing the number of dimensions and the size of each dimension.

structure - the structure to use.

Throws:

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

StructureArray

public StructureArray(Pointer pointer,
                      StructureArray array)
               throws java.lang.IllegalArgumentException

Constructs a new n-dimensional array of structures from the specified pointer to a n-dimensional array of structures with the same number of dimensions and size of each dimension as the specified n-dimensional array of structures.

Parameters:

pointer - the pointer to the n-dimensional array of structures.

array - the n-dimensional array of structures to use.

Throws:

java.lang.IllegalArgumentException - if any of the specified parameters are invalid.

Method Detail

getValueAt

public Structure getValueAt(int index)
                     throws java.lang.ArrayIndexOutOfBoundsException

Returns the structure at the specified index.

For use with one dimensional array of structures.

Parameters:

index - the index of the structure to return.

Returns:

the structure at the specified index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

getValueAt

public Structure getValueAt(int index1,
                            int index2)
                     throws java.lang.ArrayIndexOutOfBoundsException

Returns the structure at the specified index.

For use with two dimensional array of structures.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

Returns:

the structure at the specified index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

getValueAt

public Structure getValueAt(int index1,
                            int index2,
                            int index3)
                     throws java.lang.ArrayIndexOutOfBoundsException

Returns the structure at the specified index.

For use with three dimensional array of structures.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

index3 - the index into the third dimension.

Returns:

the structure at the specified index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

getValueAt

public Structure getValueAt(int[] indexes)
                     throws java.lang.ArrayIndexOutOfBoundsException

Returns the structure at the specified index.

For use with n-dimensional array of structures.

Parameters:

indexes - an array of integers representing the number of indexes and the index into each of the dimensions.

Returns:

the structure at the specified index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

setValueAt

public void setValueAt(int index,
                       Structure structure)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the structure at the specified index.

For use with one dimensional array of structures.

Parameters:

index - the index of the structure to change.

structure - the structure to use.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

setValueAt

public void setValueAt(int index1,
                       int index2,
                       Structure structure)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the structure at the specified index.

For use with two dimensional array of structures.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

structure - the structure to use.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

setValueAt

public void setValueAt(int index1,
                       int index2,
                       int index3,
                       Structure structure)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the structure at the specified index.

For use with three dimensional array of structures.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

index3 - the index into the third dimension.

structure - the structure to use.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

setValueAt

public void setValueAt(int[] indexes,
                       Structure structure)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the structure at the specified index.

For use with n-dimensional array of structures.

Parameters:

indexes - an array of integers representing the number of indexes and the index into each of the dimensions.

structure - the structure to use.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the specified index is out of bounds.

equals

public boolean equals(java.lang.Object object)

Returns whether this array of structures equals the specified object.

Overrides:

equals in class NativeArray

Parameters:

object - the object to compare against.

Returns:

whether this array of structures equals the specified object.

clone

public java.lang.Object clone()
                       throws java.lang.OutOfMemoryError

Returns a clone of this array of structures.

Specified by:

clone in class NativeObject

Returns:

the clone of this array of structures.

Throws:

java.lang.OutOfMemoryError - if there is not enough free memory.