com.dotNet4Java

Interface IClrObject

All Superinterfaces:

java.lang.AutoCloseable, IClrBase

All Known Implementing Classes:

TClrGenericObject, TClrObject, TClrStaticObject

public interface IClrObject
extends IClrBase

Represent an interface wrapper of the .Net object

Method Summary

Modifier and Type	Method and Description
<T> T	AsType(java.lang.Class<T> type) Casts the currently stored .Net value to another type.
<TResult extends TClrBase> TResult	CastTo(java.lang.Object source, IClrType type, java.lang.Class<TResult> returnClass) Cast the object to the specified type.
<TResult extends TClrBase> TResult	CastTo(java.lang.Object source, java.lang.String typeName, java.lang.Class<TResult> returnClass) Cast the object to the specified type.
java.lang.Object	getArrayElement(int index) Gets the value at the specified position in the one-dimensional Array.
int	getArrayLength() Gets the array length if the stored value is an array.
DotNetNativeTypes.ClrObject	getDefaultPointer() Gets the default clr object pointer.
<T> T	getFieldValue(java.lang.String fieldName, java.lang.Class<T> returnClass)
java.lang.String	getObjectAsString() Gets a string that represents the current object.
<T> T	getPropertyIndexValue(java.lang.String propertyName, int index, java.lang.Class<T> returnClass)
<T> T	getPropertyValue(java.lang.String propertyName, java.lang.Class<T> returnClass)
TypeCode	getTypeCode() Gets the TypeCode for the specified object.
java.lang.Object	invokeGenericMethod(java.lang.String methodName, java.lang.String[] GenericTypeNames) Invokes the generic method represented by the current object instance,using the specified parameters.
<T> T	invokeGenericMethod(java.lang.String methodName, java.lang.String[] GenericTypeNames, java.lang.Class<T> returnClass)
<T> T	invokeGenericMethod(java.lang.String methodName, java.lang.String[] GenericTypeNames, java.lang.String[] typeNames, java.lang.Object[] parameters, java.lang.Class<T> returnClass)
java.lang.Object	invokeMethod(java.lang.String methodName) Invokes the method represented by the current object instance, using the specified parameters.
<T> T	invokeMethod(java.lang.String methodName, java.lang.Class<T> returnClass)
<T> T	invokeMethod(java.lang.String methodName, java.lang.String[] typeNames, java.lang.Object[] parameters, java.lang.Class<T> returnClass)
void	invokeVoidMethod(java.lang.String methodName) Invokes the method represented by the current object instance, using the specified parameters and does not return any value.
boolean	isArray() Gets a boolean value that indicates whether the type is an array.
boolean	isEnum() Gets a boolean value indicating whether the current Type represents an enumeration.
boolean	isGeneric() Gets a boolean value indicating whether the current type is a generic type.
boolean	isStatic() Gets a boolean value indicating whether the current type is a static type.
void	setArrayElement(int index, java.lang.Object value) Sets a value to the element at the specified position in the one-dimensional Array.
IClrArray	toArray() Gets an array that represents the current object.
java.lang.Object	toObject() Gets a java object that represents the current object.
java.lang.Object	unWrap()

Methods inherited from interface com.dotNet4Java.IClrBase

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

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getDefaultPointer

DotNetNativeTypes.ClrObject getDefaultPointer()

Gets the default clr object pointer.

Returns:

the default clr object pointer.

isStatic

boolean isStatic()
          throws EClrError

Gets a boolean value indicating whether the current type is a static type.

Returns:

a value indicating whether the current type is a static type.

Throws:

EClrError

isGeneric

boolean isGeneric()
           throws EClrError

Gets a boolean value indicating whether the current type is a generic type.

Returns:

a value indicating whether the current type is a generic type.

Throws:

EClrError

isArray

boolean isArray()
         throws EClrError

Gets a boolean value that indicates whether the type is an array.

Returns:

a value that indicates whether the type is an array.

Throws:

EClrError

isEnum

boolean isEnum()
        throws EClrError

Gets a boolean value indicating whether the current Type represents an enumeration.

Returns:

a value indicating whether the current Type represents an enumeration.

Throws:

EClrError

getTypeCode

TypeCode getTypeCode()
              throws EClrError

Gets the TypeCode for the specified object.

Returns:

the TypeCode for the specified object.

Throws:

EClrError

getObjectAsString

java.lang.String getObjectAsString()
                            throws EClrError

Gets a string that represents the current object.

Returns:

a string that represents the current object.

Throws:

EClrError

toObject

java.lang.Object toObject()
                   throws EClrError

Gets a java object that represents the current object.

Returns:

a java object that represents the current object.

Throws:

EClrError

toArray

IClrArray toArray()
           throws EClrError

Gets an array that represents the current object.

Returns:

an array that represents the current object.

Throws:

EClrError

getArrayLength

int getArrayLength()
            throws EClrError

Gets the array length if the stored value is an array.

Returns:

the array length if the stored value is an array.

Throws:

EClrError

getArrayElement

java.lang.Object getArrayElement(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.

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

setArrayElement

void setArrayElement(int index,
                     java.lang.Object value)
              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.

Parameters:

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

value - The new value for the specified element.

Throws:

EClrError

getFieldValue

<T> T getFieldValue(java.lang.String fieldName,
                    java.lang.Class<T> returnClass)
             throws java.lang.Exception

Type Parameters:

T -

Parameters:

fieldName -

returnClass -

Returns:

Throws:

java.lang.Exception

getPropertyValue

<T> T getPropertyValue(java.lang.String propertyName,
                       java.lang.Class<T> returnClass)
                throws java.lang.Exception

Type Parameters:

T -

Parameters:

propertyName -

returnClass -

Returns:

Throws:

java.lang.Exception

getPropertyIndexValue

<T> T getPropertyIndexValue(java.lang.String propertyName,
                            int index,
                            java.lang.Class<T> returnClass)
                     throws java.lang.Exception

Type Parameters:

T -

Parameters:

propertyName -

index -

returnClass -

Returns:

Throws:

java.lang.Exception

invokeVoidMethod

void invokeVoidMethod(java.lang.String methodName)
               throws EClrError

Invokes the method represented by the current object instance, using the specified parameters and does not return any value.

Parameters:

methodName - The string containing the name of the public method to get.

Throws:

EClrError

invokeMethod

<T> T invokeMethod(java.lang.String methodName,
                   java.lang.Class<T> returnClass)
            throws java.lang.Exception

Type Parameters:

T -

Parameters:

methodName -

returnClass -

Returns:

Throws:

EClrError

java.lang.Exception

invokeMethod

java.lang.Object invokeMethod(java.lang.String methodName)
                       throws EClrError

Invokes the method represented by the current object instance, using the specified parameters.

Parameters:

methodName - The string containing the name of the public method to get.

Returns:

An object containing the return value of the invoked method.

Throws:

EClrError

invokeMethod

<T> T invokeMethod(java.lang.String methodName,
                   java.lang.String[] typeNames,
                   java.lang.Object[] parameters,
                   java.lang.Class<T> returnClass)
            throws java.lang.Exception

Type Parameters:

T -

Parameters:

methodName -

typeNames -

parameters -

returnClass -

Returns:

Throws:

EClrError

java.lang.Exception

invokeGenericMethod

<T> T invokeGenericMethod(java.lang.String methodName,
                          java.lang.String[] GenericTypeNames,
                          java.lang.Class<T> returnClass)
                   throws java.lang.Exception

Type Parameters:

T -

Parameters:

methodName -

GenericTypeNames -

returnClass -

Returns:

Throws:

EClrError

java.lang.Exception

invokeGenericMethod

<T> T invokeGenericMethod(java.lang.String methodName,
                          java.lang.String[] GenericTypeNames,
                          java.lang.String[] typeNames,
                          java.lang.Object[] parameters,
                          java.lang.Class<T> returnClass)
                   throws java.lang.Exception

Type Parameters:

T -

Parameters:

methodName -

GenericTypeNames -

typeNames -

parameters -

returnClass -

Returns:

Throws:

java.lang.Exception

invokeGenericMethod

java.lang.Object invokeGenericMethod(java.lang.String methodName,
                                     java.lang.String[] GenericTypeNames)
                              throws EClrError

Invokes the generic method represented by the current object instance,using the specified parameters.

Parameters:

methodName - The string containing the name of the public method to get.

GenericTypeNames - The names of the types separated by commas or semi-colon which will be substituted for the type parameters of the current object generic method definition.

Returns:

An object containing the return value of the invoked method.

Throws:

EClrError

unWrap

java.lang.Object unWrap()
                 throws EClrError

Returns:

the stored .net unwrapped object.

Throws:

EClrError

CastTo

<TResult extends TClrBase> TResult CastTo(java.lang.Object source,
                                          java.lang.String typeName,
                                          java.lang.Class<TResult> returnClass)
                                   throws java.lang.Exception

Cast the object to the specified type.

Type Parameters:

TResult - The IClrObject type

Parameters:

source - The Object to be cast to the specified type.

typeName - The type to cast the source to.

returnClass - The Java class of type IClrObject which will be created to hold reference to the cast .Net object.

Returns:

An IClrObject object cast to the specified type.

Throws:

java.lang.Exception

CastTo

<TResult extends TClrBase> TResult CastTo(java.lang.Object source,
                                          IClrType type,
                                          java.lang.Class<TResult> returnClass)
                                   throws java.lang.Exception

Cast the object to the specified type.

Type Parameters:

TResult - The IClrObject Type

Parameters:

source - The object to be casted.

type - The type of the .Net object to be converted to.

returnClass - The Java class of type IClrObject which will be created to hold reference to the cast .Net object.

Returns:

The converted object of the specified data type.

Throws:

java.lang.Exception

AsType

<T> T AsType(java.lang.Class<T> type)
      throws java.lang.Exception

Casts the currently stored .Net value to another type.

Type Parameters:

T -

Parameters:

type - The type to be converted to.

Returns:

A new, converted value if the conversion succeeded; otherwise, an exception is raised.

Throws:

java.lang.Exception