stec.jenie
Class UINT16Array

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

Direct Known Subclasses:

USHORTArray, WCHARArray

public class UINT16Array
extends NativeArray

Represents a native array of unsigned 16-bit 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

Constructor Summary

UINT16Array(int size)
Constructs a new one dimensional array of unsigned 16-bit integers of the specified number of unsigned 16-bit integers.

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

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

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

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

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

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

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

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

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

Method Summary

java.lang.Object	clone() Returns a clone of this array of unsigned 16-bit integers.
boolean	equals(java.lang.Object object) Returns whether this array of unsigned 16-bit integers equals the specified object.
int	getValueAt(int index) Returns the value at the specified index.
int	getValueAt(int[] indexes) Returns the value at the specified index.
int	getValueAt(int index1, int index2) Returns the value at the specified index.
int	getValueAt(int index1, int index2, int index3) Returns the value at the specified index.
void	setValueAt(int[] indexes, int value) Sets the value at the specified index.
void	setValueAt(int[] indexes, UINT16 value) Sets the value at the specified index.
void	setValueAt(int index, int value) Sets the value at the specified index.
void	setValueAt(int index1, int index2, int value) Sets the value at the specified index.
void	setValueAt(int index1, int index2, int index3, int value) Sets the value at the specified index.
void	setValueAt(int index1, int index2, int index3, UINT16 value) Sets the value at the specified index.
void	setValueAt(int index1, int index2, UINT16 value) Sets the value at the specified index.
void	setValueAt(int index, UINT16 value) Sets the value 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

UINT16Array

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

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

Parameters:

size - the number of 16-bit integers integers 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.

UINT16Array

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

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

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.

UINT16Array

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

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

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.

UINT16Array

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

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

Parameters:

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

UINT16Array

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

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

Parameters:

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

Throws:

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

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

UINT16Array

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

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

Parameters:

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

size - the number of 16-bit integers integers in the array.

Throws:

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

UINT16Array

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

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

Parameters:

pointer - the pointer to the two dimensional array of unsigned 16-bit 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.

UINT16Array

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

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

Parameters:

pointer - the pointer to the three dimensional array of unsigned 16-bit 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.

UINT16Array

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

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

Parameters:

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

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

Throws:

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

UINT16Array

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

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

Parameters:

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

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

Throws:

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

Method Detail

getValueAt

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

Returns the value at the specified index.

For use with one dimensional array of unsigned 16-bit integers.

Parameters:

index - the index of the value to return.

Returns:

the value at the specified index.

Throws:

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

getValueAt

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

Returns the value at the specified index.

For use with two dimensional array of unsigned 16-bit integers.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

Returns:

the value at the specified index.

Throws:

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

getValueAt

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

Returns the value at the specified index.

For use with three dimensional array of unsigned 16-bit integers.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

index3 - the index into the third dimension.

Returns:

the value at the specified index.

Throws:

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

getValueAt

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

Returns the value at the specified index.

For use with n-dimensional array of unsigned 16-bit integers.

Parameters:

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

Returns:

the value at the specified index.

Throws:

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

setValueAt

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

Sets the value at the specified index.

For use with one dimensional array of unsigned 16-bit integers.

Parameters:

index - the index of the value to change.

value - the value to use.

Throws:

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

setValueAt

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

Sets the value at the specified index.

For use with two dimensional array of unsigned 16-bit integers.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

value - the value to use.

Throws:

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

setValueAt

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

Sets the value at the specified index.

For use with three dimensional array of unsigned 16-bit integers.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

index3 - the index into the third dimension.

value - the value to use.

Throws:

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

setValueAt

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

Sets the value at the specified index.

For use with n-dimensional array of unsigned 16-bit integers.

Parameters:

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

value - the value to use.

Throws:

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

setValueAt

public void setValueAt(int index,
                       UINT16 value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with one dimensional array of unsigned 16-bit integers.

Parameters:

index - the index of the value to change.

value - the value to use.

Throws:

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

setValueAt

public void setValueAt(int index1,
                       int index2,
                       UINT16 value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with two dimensional array of unsigned 16-bit integers.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

value - the value to use.

Throws:

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

setValueAt

public void setValueAt(int index1,
                       int index2,
                       int index3,
                       UINT16 value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with three dimensional array of unsigned 16-bit integers.

Parameters:

index1 - the index into the first dimension.

index2 - the index into the second dimension.

index3 - the index into the third dimension.

value - the value to use.

Throws:

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

setValueAt

public void setValueAt(int[] indexes,
                       UINT16 value)
                throws java.lang.ArrayIndexOutOfBoundsException

Sets the value at the specified index.

For use with n-dimensional array of unsigned 16-bit integers.

Parameters:

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

value - the value 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 unsigned 16-bit integers equals the specified object.

Overrides:

equals in class NativeArray

Parameters:

object - the object to compare against.

Returns:

whether this array of unsigned 16-bit integers equals the specified object.

clone

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

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

Specified by:

clone in class NativeObject

Returns:

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

Throws:

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