stec.jenie
Class BYTEArray

java.lang.Object
  stec.jenie.NativeObject
      stec.jenie.NativeArray
          stec.jenie.UINT8Array
              stec.jenie.BYTEArray

public class BYTEArray
extends UINT8Array

Represents a native array of unsigned 8-bit bytes.

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:

UINT8Array

Constructor Summary

BYTEArray(BYTEArray array)
Constructs a new n-dimensional array of unsigned 8-bit bytes with the same number of dimensions and size of each dimension as the specified unsigned 8-bit byte native array.

BYTEArray(int size)
Constructs a new one dimensional array of unsigned 8-bit bytes of specified number of bytes.

BYTEArray(int[] dimensions)
Constructs a new n-dimensional array of unsigned 8-bit bytes of specified number of bytes.

BYTEArray(int size1, int size2)
Constructs a new two dimensional array of unsigned 8-bit bytes of specified number of bytes.

BYTEArray(int size1, int size2, int size3)
Constructs a new three dimensional array of unsigned 8-bit bytes of specified number of bytes.

BYTEArray(Pointer pointer, BYTEArray array)
Constructs a new n-dimensional array of unsigned 8-bit bytes from the specified pointer to a n-dimensional array of unsigned 8-bit bytes with the same number of dimensions and size of each dimension as the specified unsigned 8-bit byte native array.

BYTEArray(Pointer pointer, int size)
Constructs a new one dimensional array of unsigned 8-bit bytes from the specified pointer to a one dimensional array of unsigned 8-bit bytes of specified number of bytes.

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

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

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

Method Summary

java.lang.Object

clone() Returns a clone of this array of unsigned 8-bit bytes.

Methods inherited from class stec.jenie.UINT8Array

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

BYTEArray

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

Constructs a new one dimensional array of unsigned 8-bit bytes of specified number of bytes.

Parameters:

size - the number of bytes in the array.

Throws:

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

java.lang.IllegalArgumentException

BYTEArray

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

Constructs a new two dimensional array of unsigned 8-bit bytes of specified number of bytes.

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.

BYTEArray

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

Constructs a new three dimensional array of unsigned 8-bit bytes of specified number of bytes.

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.

BYTEArray

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

Constructs a new n-dimensional array of unsigned 8-bit bytes of specified number of bytes.

Parameters:

dimensions - an array of bytes 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.

BYTEArray

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

Constructs a new n-dimensional array of unsigned 8-bit bytes with the same number of dimensions and size of each dimension as the specified unsigned 8-bit byte native array.

Parameters:

array - the n-dimensional array of unsigned 8-bit bytes to use.

Throws:

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

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

BYTEArray

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

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

Parameters:

pointer - the pointer to the one dimensional array of unsigned 8-bit bytes.

size - the number of bytes in the array.

Throws:

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

BYTEArray

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

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

Parameters:

pointer - the pointer to the two dimensional array of unsigned 8-bit bytes.

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.

BYTEArray

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

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

Parameters:

pointer - the pointer to the three dimensional array of unsigned 8-bit bytes.

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.

BYTEArray

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

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

Parameters:

pointer - the pointer to the n-dimensional array of unsigned 8-bit bytes.

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

Throws:

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

BYTEArray

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

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

Parameters:

pointer - the pointer to the n-dimensional array of unsigned 8-bit bytes.

array - the n-dimensional array of unsigned 8-bit bytes 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 unsigned 8-bit bytes.

Overrides:

clone in class UINT8Array

Returns:

the clone of this array of unsigned 8-bit bytes.

Throws:

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