com.dotNet4Java

Class TClrArray

java.lang.Object

com.dotNet4Java.TClrBase

com.dotNet4Java.TClrArray

All Implemented Interfaces:

IClrArray, IClrBase, java.lang.AutoCloseable

Direct Known Subclasses:

TClrGenericArray, TClrObjectArray

public class TClrArray
extends TClrBase
implements IClrArray

Provides methods for creating, manipulating, searching, and sorting arrays, thereby serving as the base class for all arrays in the common language runtime (Clr).

Constructor Summary

Constructors

Modifier	Constructor and Description
	TClrArray(DotNetNativeTypes.ClrArray array) Create an instance of a one-dimensional Array from the clr array pointer.
	TClrArray(DotNetNativeTypes.ClrObject clrObject) Create an instance of a one-dimensional Array from the clr Object pointer which represents a pointer to a clr array.
protected	TClrArray(DotNetNativeTypes.ClrType elementType, int length) Creates a one-dimensional Array of the specified Type and length, with zero-based indexing.
protected	TClrArray(IClrType elementType, int length) Creates a one-dimensional Array of the specified Type and length, with zero-based indexing.
protected	TClrArray(java.lang.String elementTypeName, int length) Creates a one-dimensional Array of the specified Type and length, with zero-based indexing.

Method Summary

Modifier and Type	Method and Description
void	close()
static IClrArray	createAssemblyArray(int length) Creates a one-dimensional Array of Assembly with the specified length, using zero-based indexing.
static IClrArray	createBooleanArray(int length) Creates a one-dimensional Array of boolean with the specified length, using zero-based indexing.
static IClrArray	createByteArray(int length) Creates a one-dimensional Array of byte with the specified length, using zero-based indexing.
static DotNetNativeTypes.ClrArray	createClrArray(java.lang.Class<?> arrayElementType, int length)
static IClrArray	createDateTimeArray(int length) Creates a one-dimensional Array of clr DateTime with the specified length, using zero-based indexing.
static IClrArray	createDecimalArray(int length) Creates a one-dimensional Array of clr Decimal with the specified length, using zero-based indexing.
static IClrArray	createDoubleArray(int length) Creates a one-dimensional Array of double with the specified length, using zero-based indexing.
static IClrArray	createFloatArray(int length) Creates a one-dimensional Array of float with the specified length, using zero-based indexing.
static IClrArray	createInstance(IClrType elementType, int length) Creates a one-dimensional Array of the specified Type and length, with zero-based indexing.
static IClrArray	createInstance(java.lang.String elementTypeName, int length) Creates a one-dimensional Array of the specified Type and length, with zero-based indexing.
static IClrArray	createIntArray(int length) Creates a one-dimensional Array of integer with the specified length, using zero-based indexing.
static IClrArray	createLongArray(int length) Creates a one-dimensional Array of long with the specified length, using zero-based indexing.
static IClrArray	createObjectArray(int length) Creates a one-dimensional Array of .Net object with the specified length, using zero-based indexing.
static IClrArray	createSByteArray(int length) Creates a one-dimensional Array of sbyte/byte with the specified length, using zero-based indexing.
static IClrArray	createShortArray(int length) Creates a one-dimensional Array of short with the specified length, using zero-based indexing.
static IClrArray	createStringArray(int length) Creates a one-dimensional Array of string with the specified length, using zero-based indexing.
static IClrArray	createTypeArray(int length) Creates a one-dimensional Array of Type with the specified length, using zero-based indexing.
static java.lang.Object[]	emptyObjectArray()
protected DotNetNativeTypes.ClrObject	getClrObject() Gets the base clr object pointer.
DotNetNativeTypes.ClrArray	getDefaultPointer() Gets the default clr array pointer.
IClrType	getElementType() Returns the Type of the object encompassed or referred to by the current array, pointer or reference type.
int	getLength() Gets the total number of elements in all the dimensions of the Array; zero if there are no elements in the array.
protected DotNetNativeTypes.ClrObject	getStaticArray() Create a static .Net System.Array object type.
IClrType	getType() Gets the exact runtime type of the current instance.
protected <T> T	getValue(java.lang.Class<T> clazz, int index) Gets the element at the specified index.
java.lang.Object	getValue(int index) Gets the value at the specified position in the one-dimensional Array.
int	indexOf(java.lang.Object value) Searches for the specified object and returns the index of its first occurrence in a one-dimensional array.
static java.lang.Object[]	of(java.lang.Object... paramArray) Converts an Object params to an array of Object.
static java.lang.String[]	of(java.lang.String... paramArray) Converts a String params to an array of String.
protected void	setValue(java.lang.Class<?> clazz, java.lang.Object value, int index) Sets the element at the specified index.
void	setValue(java.lang.Object value, int index) Sets a value to the element at the specified position in the one-dimensional Array.
DotNetNativeTypes.ClrObject	toClrObject() Gets the Clr base object Converts the value of the Array to a base object.
static <T> T[]	toObjectArray(DotNetNativeTypes.ClrArray clrArray, java.lang.Class<T> componentClass)

Methods inherited from class com.dotNet4Java.TClrBase

clearRef, equals, getBaseObject, getFieldValue, getPropertyIndexValue, getPropertyIndexValue, getPropertyValue, invokeGenericClrObjectMethod, invokeGenericMethod, invokeMethod, invokeVoidMethod, registerEvent, registerEventCallBack, registerEventCallBackWithReturn, setFieldValue, setPropertyIndexValue, setPropertyIndexValue, setPropertyValue, unRegisterEvent, unRegisterEventCallBack, unRegisterEventCallBackWithReturn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.dotNet4Java.IClrArray

New

Methods inherited from interface com.dotNet4Java.IClrBase

equals, getBaseObject, getFieldValue, getPropertyIndexValue, getPropertyIndexValue, getPropertyValue, invokeGenericMethod, invokeMethod, invokeVoidMethod, registerEventCallBack, registerEventCallBackWithReturn, setFieldValue, setPropertyIndexValue, setPropertyIndexValue, setPropertyValue, unRegisterEventCallBack, unRegisterEventCallBackWithReturn

Constructor Detail

TClrArray

protected TClrArray(IClrType elementType,
                    int length)
             throws EClrError

Creates a one-dimensional Array of the specified Type and length, with zero-based indexing.

Parameters:

elementType - The Type of the Array to create.

length - The size of the Array to create.

Throws:

EClrError

TClrArray

protected TClrArray(DotNetNativeTypes.ClrType elementType,
                    int length)
             throws EClrError

Creates a one-dimensional Array of the specified Type and length, with zero-based indexing.

Parameters:

elementType - The Clr Type pointer of the Array to create.

length - The size of the Array to create.

Throws:

EClrError

TClrArray

protected TClrArray(java.lang.String elementTypeName,
                    int length)
             throws EClrError

Creates a one-dimensional Array of the specified Type and length, with zero-based indexing.

Parameters:

elementTypeName -

length - The size of the Array to create.

Throws:

EClrError

TClrArray

public TClrArray(DotNetNativeTypes.ClrObject clrObject)
          throws EClrError

Create an instance of a one-dimensional Array from the clr Object pointer which represents a pointer to a clr array.

Parameters:

clrObject - The clr object pointer which represents a pointer to a clr array.

Throws:

EClrError

TClrArray

public TClrArray(DotNetNativeTypes.ClrArray array)

Create an instance of a one-dimensional Array from the clr array pointer.

Parameters:

array - The clr array pointer.

Method Detail

createInstance

public static final IClrArray createInstance(java.lang.String elementTypeName,
                                             int length)
                                      throws EClrError

Creates a one-dimensional Array of the specified Type and length, with zero-based indexing.

Parameters:

elementTypeName - The Type name of the Array to create.

length - The size of the Array to create.

Returns:

A new one-dimensional Array of the specified Type with the specified length, using zero-based indexing.

Throws:

EClrError

createInstance

public static final IClrArray createInstance(IClrType elementType,
                                             int length)
                                      throws EClrError

Creates a one-dimensional Array of the specified Type and length, with zero-based indexing.

Parameters:

elementType - The Type of the Array to create.

length - The size of the Array to create.

Returns:

A new one-dimensional Array of the specified Type with the specified length, using zero-based indexing.

Throws:

EClrError

createObjectArray

public static final IClrArray createObjectArray(int length)
                                         throws EClrError

Creates a one-dimensional Array of .Net object with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of .Net object with the specified length, using zero-based indexing.

Throws:

EClrError

createBooleanArray

public static final IClrArray createBooleanArray(int length)
                                          throws EClrError

Creates a one-dimensional Array of boolean with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of boolean with the specified length, using zero-based indexing.

Throws:

EClrError

createSByteArray

public static final IClrArray createSByteArray(int length)
                                        throws EClrError

Creates a one-dimensional Array of sbyte/byte with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of sbyte with the specified length, using zero-based indexing.

Throws:

EClrError

createByteArray

public static final IClrArray createByteArray(int length)
                                       throws EClrError

Creates a one-dimensional Array of byte with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of byte with the specified length, using zero-based indexing.

Throws:

EClrError

createIntArray

public static final IClrArray createIntArray(int length)
                                      throws EClrError

Creates a one-dimensional Array of integer with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of integer with the specified length, using zero-based indexing.

Throws:

EClrError

createShortArray

public static final IClrArray createShortArray(int length)
                                        throws EClrError

Creates a one-dimensional Array of short with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of short with the specified length, using zero-based indexing.

Throws:

EClrError

createLongArray

public static final IClrArray createLongArray(int length)
                                       throws EClrError

Creates a one-dimensional Array of long with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of long with the specified length, using zero-based indexing.

Throws:

EClrError

createFloatArray

public static final IClrArray createFloatArray(int length)
                                        throws EClrError

Creates a one-dimensional Array of float with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of float with the specified length, using zero-based indexing.

Throws:

EClrError

createStringArray

public static final IClrArray createStringArray(int length)
                                         throws EClrError

Creates a one-dimensional Array of string with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of string with the specified length, using zero-based indexing.

Throws:

EClrError

createDoubleArray

public static final IClrArray createDoubleArray(int length)
                                         throws EClrError

Creates a one-dimensional Array of double with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of double with the specified length, using zero-based indexing.

Throws:

EClrError

createDateTimeArray

public static final IClrArray createDateTimeArray(int length)
                                           throws EClrError

Creates a one-dimensional Array of clr DateTime with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of clr DateTime with the specified length, using zero-based indexing.

Throws:

EClrError

createDecimalArray

public static final IClrArray createDecimalArray(int length)
                                          throws EClrError

Creates a one-dimensional Array of clr Decimal with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of clr Decimal with the specified length, using zero-based indexing.

Throws:

EClrError

createTypeArray

public static final IClrArray createTypeArray(int length)
                                       throws EClrError

Creates a one-dimensional Array of Type with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of Type with the specified length, using zero-based indexing.

Throws:

EClrError

createAssemblyArray

public static final IClrArray createAssemblyArray(int length)
                                           throws EClrError

Creates a one-dimensional Array of Assembly with the specified length, using zero-based indexing.

Parameters:

length - The size of the Array to create.

Returns:

A new one-dimensional Array of Assembly with the specified length, using zero-based indexing.

Throws:

EClrError

of

public static final java.lang.String[] of(java.lang.String... paramArray)

Converts a String params to an array of String.

Parameters:

paramArray - A String params argument to be converted.

Returns:

of

public static final java.lang.Object[] of(java.lang.Object... paramArray)

Converts an Object params to an array of Object.

Parameters:

paramArray - An Object params argument to be converted.

Returns:

toObjectArray

public static <T> T[] toObjectArray(DotNetNativeTypes.ClrArray clrArray,
                                    java.lang.Class<T> componentClass)
                             throws java.lang.Exception

Type Parameters:

T -

Parameters:

clrArray -

componentClass -

Returns:

Throws:

java.lang.Exception

createClrArray

public static final DotNetNativeTypes.ClrArray createClrArray(java.lang.Class<?> arrayElementType,
                                                              int length)
                                                       throws EClrError

Parameters:

arrayElementType -

length -

Returns:

Throws:

EClrError

emptyObjectArray

public static final java.lang.Object[] emptyObjectArray()

getClrObject

protected DotNetNativeTypes.ClrObject getClrObject()
                                            throws EClrError

Gets the base clr object pointer.

Specified by:

getClrObject in class TClrBase

Returns:

The base clr object pointer.

Throws:

EClrError

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class TClrBase

Throws:

java.lang.Exception

getStaticArray

protected DotNetNativeTypes.ClrObject getStaticArray()
                                              throws EClrError

Create a static .Net System.Array object type.

Returns:

A .Net System.Array type object.

Throws:

EClrError

getDefaultPointer

public DotNetNativeTypes.ClrArray getDefaultPointer()

Gets the default clr array pointer.

Specified by:

getDefaultPointer in interface IClrArray

Returns:

the default clr array pointer.

getLength

public int getLength()
              throws EClrError

Gets the total number of elements in all the dimensions of the Array; zero if there are no elements in the array.

Specified by:

getLength in interface IClrArray

Returns:

The total number of elements in all the dimensions of the Array; zero if there are no elements in the array.

Throws:

EClrError

getValue

protected <T> T getValue(java.lang.Class<T> clazz,
                         int index)
                  throws java.lang.Exception

Gets the element at the specified index.

Type Parameters:

T - The element at the specified index.

Parameters:

clazz - The class of the element to get.

index - The zero-based index of the element to get.

Returns:

Throws:

EClrError

java.lang.Exception

getValue

public java.lang.Object getValue(int index)
                          throws EClrError

Gets the value at the specified position in the one-dimensional Array. The index is specified as a 32-bit integer.

Specified by:

getValue in interface IClrArray

Parameters:

index - A 32-bit integer that represents the position of the Array element to get.

Returns:

The value at the specified position in the one-dimensional Array.

Throws:

EClrError

indexOf

public int indexOf(java.lang.Object value)
            throws EClrError

Searches for the specified object and returns the index of its first occurrence in a one-dimensional array.

Specified by:

indexOf in interface IClrArray

Parameters:

value - The object to locate in array.

Returns:

The index of the first occurrence of value in array, if found; otherwise, the lower bound of the array minus 1.

Throws:

EClrError

setValue

protected void setValue(java.lang.Class<?> clazz,
                        java.lang.Object value,
                        int index)
                 throws EClrError

Sets the element at the specified index.

Parameters:

clazz - The class of the element to set.

value - The new value for the specified element.

index - The zero-based index of the element to set.

Throws:

EClrError

setValue

public void setValue(java.lang.Object value,
                     int index)
              throws EClrError

Sets a value to the element at the specified position in the one-dimensional Array. The index is specified as a 32-bit integer.

Specified by:

setValue in interface IClrArray

Parameters:

value - The new value for the specified element.

index - A 32-bit integer that represents the position of the Array element to set.

Throws:

EClrError

getElementType

public IClrType getElementType()
                        throws EClrError

Returns the Type of the object encompassed or referred to by the current array, pointer or reference type.

Specified by:

getElementType in interface IClrArray

Returns:

The Type of the object encompassed or referred to by the current array, pointer, or reference type, or null if the current Type is not an array or a pointer, or is not passed by reference, or represents a generic type or a type parameter in the definition of a generic type or generic method.

Throws:

EClrError

toClrObject

public DotNetNativeTypes.ClrObject toClrObject()
                                        throws EClrError

Gets the Clr base object Converts the value of the Array to a base object.

Specified by:

toClrObject in interface IClrArray

Returns:

the Clr base object Converts the value of the Array to a base object.

Throws:

EClrError

getType

public IClrType getType()
                 throws EClrError

Gets the exact runtime type of the current instance.

Specified by:

getType in interface IClrArray

Specified by:

getType in interface IClrBase

Overrides:

getType in class TClrBase

Returns:

the exact runtime type of the current instance.

Throws:

EClrError