stec.jenie
Class CHARArray

java.lang.Object
  stec.jenie.NativeObject
      stec.jenie.NativeArray
          stec.jenie.INT8Array
              stec.jenie.CHARArray

public class CHARArray
extends INT8Array

Represents a native array of signed 8-bit characters.

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

Since:

1.0.0 12/05/2004

See Also:

INT8Array

Constructor Summary

CHARArray(CHARArray array)
Constructs a new n-dimensional array of signed 8-bit characters with the same number of dimensions and size of each dimension as the specified signed 8-bit character native array.

CHARArray(int size)
Constructs a new one dimensional array of signed 8-bit characters of specified number of characters.

CHARArray(int[] dimensions)
Constructs a new n-dimensional array of signed 8-bit characters of specified number of characters.

CHARArray(int size1, int size2)
Constructs a new two dimensional array of signed 8-bit characters of specified number of characters.

CHARArray(int size1, int size2, int size3)
Constructs a new three dimensional array of signed 8-bit characters of specified number of characters.

CHARArray(Pointer pointer, CHARArray array)
Constructs a new n-dimensional array of signed 8-bit characters from the specified pointer to a n-dimensional array of signed 8-bit characters with the same number of dimensions and size of each dimension as the specified signed 8-bit character native array.

CHARArray(Pointer pointer, int size)
Constructs a new one dimensional array of signed 8-bit characters from the specified pointer to a one dimensional array of signed 8-bit characters of specified number of characters.

CHARArray(Pointer pointer, int[] dimensions)
Constructs a new n-dimensional array of signed 8-bit characters from the specified pointer to a n-dimensional array of signed 8-bit characters of specified number of characters.

CHARArray(Pointer pointer, int size1, int size2)
Constructs a new two dimensional array of signed 8-bit characters from the specified pointer to a two dimensional array of signed 8-bit characters of specified number of characters.

CHARArray(Pointer pointer, int size1, int size2, int size3)
Constructs a new three dimensional array of signed 8-bit characters from the specified pointer to a three dimensional array of signed 8-bit characters of specified number of characters.

Method Summary

java.lang.Object

clone() Returns a clone of this array of signed 8-bit characters.

Methods inherited from class stec.jenie.INT8Array

equals, getValueAt, getValueAt, getValueAt, getValueAt, setValueAt, setValueAt, setValueAt, setValueAt, setValueAt, setValueAt, setValueAt, setValueAt

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

CHARArray

public CHARArray(int size)
          throws java.lang.OutOfMemoryError,
                 java.lang.IllegalArgumentException

Constructs a new one dimensional array of signed 8-bit characters of specified number of characters.

Parameters:

size - the number of characters in the array.

Throws:

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

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

CHARArray

public CHARArray(int size1,
                 int size2)
          throws java.lang.OutOfMemoryError,
                 java.lang.IllegalArgumentException

Constructs a new two dimensional array of signed 8-bit characters of specified number of characters.

Parameters:

size1 - the size of the first dimension.

size2 - the size of the second dimension.

Throws:

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

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

CHARArray

public CHARArray(int size1,
                 int size2,
                 int size3)
          throws java.lang.OutOfMemoryError,
                 java.lang.IllegalArgumentException

Constructs a new three dimensional array of signed 8-bit characters of specified number of characters.

Parameters:

size1 - the size of the first dimension.

size2 - the size of the second dimension.

size3 - the size of the third dimension.

Throws:

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

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

CHARArray

public CHARArray(int[] dimensions)
          throws java.lang.OutOfMemoryError,
                 java.lang.IllegalArgumentException

Constructs a new n-dimensional array of signed 8-bit characters of specified number of characters.

Parameters:

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

Throws:

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

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

CHARArray

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

Constructs a new n-dimensional array of signed 8-bit characters with the same number of dimensions and size of each dimension as the specified signed 8-bit character native array.

Parameters:

array - the n-dimensional array of signed 8-bit characters to use.

Throws:

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

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

CHARArray

public CHARArray(Pointer pointer,
                 int size)
          throws java.lang.IllegalArgumentException

Constructs a new one dimensional array of signed 8-bit characters from the specified pointer to a one dimensional array of signed 8-bit characters of specified number of characters.

Parameters:

pointer - the pointer to the one dimensional array of signed 8-bit characters.

size - the number of characters in the array.

Throws:

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

CHARArray

public CHARArray(Pointer pointer,
                 int size1,
                 int size2)
          throws java.lang.IllegalArgumentException

Constructs a new two dimensional array of signed 8-bit characters from the specified pointer to a two dimensional array of signed 8-bit characters of specified number of characters.

Parameters:

pointer - the pointer to the two dimensional array of signed 8-bit characters.

size1 - the size of the first dimension.

size2 - the size of the second dimension.

Throws:

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

CHARArray

public CHARArray(Pointer pointer,
                 int size1,
                 int size2,
                 int size3)
          throws java.lang.IllegalArgumentException

Constructs a new three dimensional array of signed 8-bit characters from the specified pointer to a three dimensional array of signed 8-bit characters of specified number of characters.

Parameters:

pointer - the pointer to the three dimensional array of signed 8-bit characters.

size1 - the size of the first dimension.

size2 - the size of the second dimension.

size3 - the size of the third dimension.

Throws:

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

CHARArray

public CHARArray(Pointer pointer,
                 int[] dimensions)
          throws java.lang.IllegalArgumentException

Constructs a new n-dimensional array of signed 8-bit characters from the specified pointer to a n-dimensional array of signed 8-bit characters of specified number of characters.

Parameters:

pointer - the pointer to the n-dimensional array of signed 8-bit characters.

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

Throws:

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

CHARArray

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

Constructs a new n-dimensional array of signed 8-bit characters from the specified pointer to a n-dimensional array of signed 8-bit characters with the same number of dimensions and size of each dimension as the specified signed 8-bit character native array.

Parameters:

pointer - the pointer to the n-dimensional array of signed 8-bit characters.

array - the n-dimensional array of signed 8-bit characters to use.

Throws:

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

Method Detail

clone

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

Returns a clone of this array of signed 8-bit characters.

Overrides:

clone in class INT8Array

Returns:

the clone of this array of signed 8-bit characters.

Throws:

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