stec.jenie
Class USHORTArray

java.lang.Object
  stec.jenie.NativeObject
      stec.jenie.NativeArray
          stec.jenie.UINT16Array
              stec.jenie.USHORTArray

public class USHORTArray
extends UINT16Array

Represents a native array of unsigned 16-bit short integers.

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:

UINT16Array

Constructor Summary

USHORTArray(int size)
Constructs a new one dimensional array of unsigned 16-bit short integers of specified number of shorts.

USHORTArray(int[] dimensions)
Constructs a new n-dimensional array of unsigned 16-bit short integers of specified number of shorts.

USHORTArray(int size1, int size2)
Constructs a new two dimensional array of unsigned 16-bit short integers of specified number of shorts.

USHORTArray(int size1, int size2, int size3)
Constructs a new three dimensional array of unsigned 16-bit short integers of specified number of shorts.

USHORTArray(Pointer pointer, int size)
Constructs a new one dimensional array of unsigned 16-bit short integers from the specified pointer to a one dimensional array of unsigned 16-bit short integers of specified number of shorts.

USHORTArray(Pointer pointer, int[] dimensions)
Constructs a new n-dimensional array of unsigned 16-bit short integers from the specified pointer to a n-dimensional array of unsigned 16-bit short integers of specified number of shorts.

USHORTArray(Pointer pointer, int size1, int size2)
Constructs a new two dimensional array of unsigned 16-bit short integers from the specified pointer to a two dimensional array of unsigned 16-bit short integers of specified number of shorts.

USHORTArray(Pointer pointer, int size1, int size2, int size3)
Constructs a new three dimensional array of unsigned 16-bit short integers from the specified pointer to a three dimensional array of unsigned 16-bit short integers of specified number of shorts.

USHORTArray(Pointer pointer, USHORTArray array)
Constructs a new n-dimensional array of unsigned 16-bit short integers from the specified pointer to a n-dimensional array of unsigned 16-bit short integers with the same number of dimensions and size of each dimension as the specified n-dimensional array of unsigned 16-bit short integers.

USHORTArray(USHORTArray array)
Constructs a new n-dimensional array of unsigned 16-bit short integers with the same number of dimensions and size of each dimension as the specified n-dimensional array of unsigned 16-bit short integers.

Method Summary

java.lang.Object

clone() Returns a clone of this array of unsigned 16-bit short integers.

Methods inherited from class stec.jenie.UINT16Array

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

USHORTArray

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

Constructs a new one dimensional array of unsigned 16-bit short integers of specified number of shorts.

Parameters:

size - the number of shorts 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.

USHORTArray

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

Constructs a new two dimensional array of unsigned 16-bit short integers of specified number of shorts.

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.

USHORTArray

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

Constructs a new three dimensional array of unsigned 16-bit short integers of specified number of shorts.

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.

USHORTArray

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

Constructs a new n-dimensional array of unsigned 16-bit short integers of specified number of shorts.

Parameters:

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

USHORTArray

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

Constructs a new n-dimensional array of unsigned 16-bit short integers with the same number of dimensions and size of each dimension as the specified n-dimensional array of unsigned 16-bit short integers.

Parameters:

array - the n-dimensional array of unsigned 16-bit shorts to use.

Throws:

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

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

USHORTArray

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

Constructs a new one dimensional array of unsigned 16-bit short integers from the specified pointer to a one dimensional array of unsigned 16-bit short integers of specified number of shorts.

Parameters:

pointer - the pointer to the one dimensional array of unsigned 16-bit short integers.

size - the number of shorts in the array.

Throws:

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

USHORTArray

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

Constructs a new two dimensional array of unsigned 16-bit short integers from the specified pointer to a two dimensional array of unsigned 16-bit short integers of specified number of shorts.

Parameters:

pointer - the pointer to the two dimensional array of unsigned 16-bit short integers.

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.

USHORTArray

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

Constructs a new three dimensional array of unsigned 16-bit short integers from the specified pointer to a three dimensional array of unsigned 16-bit short integers of specified number of shorts.

Parameters:

pointer - the pointer to the three dimensional array of unsigned 16-bit short integers.

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.

USHORTArray

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

Constructs a new n-dimensional array of unsigned 16-bit short integers from the specified pointer to a n-dimensional array of unsigned 16-bit short integers of specified number of shorts.

Parameters:

pointer - the pointer to the n-dimensional array of unsigned 16-bit short integers.

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

Throws:

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

USHORTArray

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

Constructs a new n-dimensional array of unsigned 16-bit short integers from the specified pointer to a n-dimensional array of unsigned 16-bit short integers with the same number of dimensions and size of each dimension as the specified n-dimensional array of unsigned 16-bit short integers.

Parameters:

pointer - the pointer to the n-dimensional array of unsigned 16-bit short integers.

array - the n-dimensional array of unsigned 16-bit short integers 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 16-bit short integers.

Overrides:

clone in class UINT16Array

Returns:

the clone of this array of unsigned 16-bit short integers.

Throws:

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