com.dotNet4Java

Class TClrBase

java.lang.Object

com.dotNet4Java.TClrBase

All Implemented Interfaces:

IClrBase, java.lang.AutoCloseable

Direct Known Subclasses:

TClrAppDomain, TClrArray, TClrAssembly, TClrObject, TClrType

public abstract class TClrBase
extends java.lang.Object
implements IClrBase, java.lang.AutoCloseable

This is the ultimate base class of all .Net CLR classes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TClrBase() Initializes a new instance of the TClrBase class.
protected	TClrBase(DotNetNativeTypes.ClrObject clrObject) Initializes a new instance of the TClrBase class with the specified clr object pointer.

Method Summary

Modifier and Type	Method and Description
protected void	clearRef(java.util.Map map, java.lang.Class elementClass)
void	close()
boolean	equals(IClrBase baseObject) Determines whether the specified object is equal to the current object.
DotNetNativeTypes.ClrObject	getBaseObject() Gets the default clr object pointer.
protected abstract DotNetNativeTypes.ClrObject	getClrObject() Gets the base clr object pointer.
java.lang.Object	getFieldValue(java.lang.String fieldName) Returns the value of a field with the specified name.
java.lang.Object	getPropertyIndexValue(java.lang.String propertyName, int Index) Returns the property value of a specified object with specified property name and index value for indexed properties.
java.lang.Object	getPropertyIndexValue(java.lang.String propertyName, java.lang.String[] typeNames, java.lang.Object[] indices) Searches for the public property with the specified name and returns the property index value of a specified indexer object.
java.lang.Object	getPropertyValue(java.lang.String propertyName) Returns the property value of a specified object using the specified property name.
IClrType	getType() Gets the exact runtime type of the current instance.
protected DotNetNativeTypes.ClrObject	invokeGenericClrObjectMethod(java.lang.String methodName, java.lang.String[] genericTypeNames, java.lang.String[] ParameterTypeNames, java.lang.Object[] parameters)
java.lang.Object	invokeGenericMethod(java.lang.String methodName, java.lang.String[] genericTypeNames, java.lang.String[] ParameterTypeNames, java.lang.Object[] parameters) Invokes the generic method represented by the current object instance,using the specified parameters.
java.lang.Object	invokeMethod(java.lang.String methodName, java.lang.String[] typeNames, java.lang.Object[] parameters) Invokes the method represented by the current object instance, using thespecified parameters.
void	invokeVoidMethod(java.lang.String methodName, java.lang.String[] typeNames, java.lang.Object[] parameters) Invokes the method represented by the current object instance, using the specified parameters and does not return any value.
protected void	registerEvent() Register the source of the event
void	registerEventCallBack(java.lang.String eventName, DotNetNativeTypes.IClrEventHandler callBack) Add an event to the current object using the specified event name and function pointer which is the event handler.
void	registerEventCallBackWithReturn(java.lang.String eventName, DotNetNativeTypes.IClrEventHandlerReturn callBack) Add an event to the current object using the specified event name and function pointer which is the event handler.
void	setFieldValue(java.lang.String fieldName, java.lang.Object value) Sets the value of the field with the specified name supported by the given object.
void	setPropertyIndexValue(java.lang.String propertyName, int Index, java.lang.Object value) Sets the property value of a specified object with property name andindex value for index properties.
void	setPropertyIndexValue(java.lang.String propertyName, java.lang.String[] typeNames, java.lang.Object[] indices, java.lang.Object value) Sets the property value of a specified object with optional index values for index properties.
void	setPropertyValue(java.lang.String propertyName, java.lang.Object value) Sets the property value of a specified object using the specified property name.
protected void	unRegisterEvent() UnRegister the source of the event
void	unRegisterEventCallBack(java.lang.String eventName, DotNetNativeTypes.IClrEventHandler callBack) Remove an event from the current object using the specified event name and function pointer which is the event handler.
void	unRegisterEventCallBackWithReturn(java.lang.String eventName, DotNetNativeTypes.IClrEventHandlerReturn callBack) Remove an event from the current object using the specified event name and function pointer which is the event handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

TClrBase

protected TClrBase()

Initializes a new instance of the TClrBase class.

TClrBase

protected TClrBase(DotNetNativeTypes.ClrObject clrObject)

Initializes a new instance of the TClrBase class with the specified clr object pointer.

Parameters:

clrObject - Specifies clr object pointer

Method Detail

getClrObject

protected abstract DotNetNativeTypes.ClrObject getClrObject()
                                                     throws EClrError

Gets the base clr object pointer.

Returns:

The base clr object pointer.

Throws:

EClrError

registerEvent

protected void registerEvent()
                      throws EClrError

Register the source of the event

Throws:

EClrError

unRegisterEvent

protected void unRegisterEvent()

UnRegister the source of the event

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

getBaseObject

public DotNetNativeTypes.ClrObject getBaseObject()
                                          throws EClrError

Gets the default clr object pointer.

Specified by:

getBaseObject in interface IClrBase

Returns:

the default clr object pointer.

Throws:

EClrError

getType

public IClrType getType()
                 throws EClrError

Gets the exact runtime type of the current instance.

Specified by:

getType in interface IClrBase

Returns:

the exact runtime type of the current instance.

Throws:

EClrError

equals

public boolean equals(IClrBase baseObject)
               throws EClrError

Determines whether the specified object is equal to the current object.

Specified by:

equals in interface IClrBase

Parameters:

baseObject - The object to compare with the current object.

Returns:

true if the specified object is equal to the current object; otherwise, false.

Throws:

EClrError

getFieldValue

public java.lang.Object getFieldValue(java.lang.String fieldName)
                               throws EClrError

Returns the value of a field with the specified name.

Specified by:

getFieldValue in interface IClrBase

Parameters:

fieldName - The string containing the name of the data field to get.

Returns:

An object containing the value of the field reflected by the current instance.

Throws:

EClrError

setFieldValue

public void setFieldValue(java.lang.String fieldName,
                          java.lang.Object value)
                   throws EClrError

Sets the value of the field with the specified name supported by the given object.

Specified by:

setFieldValue in interface IClrBase

Parameters:

fieldName - The string containing the name of the data field to get.

value - The value to assign to the field.

Throws:

EClrError

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String propertyName)
                                  throws EClrError

Returns the property value of a specified object using the specified property name.

Specified by:

getPropertyValue in interface IClrBase

Parameters:

propertyName - The string containing the name of the public property to get.

Returns:

The property value of the specified object.

Throws:

EClrError

setPropertyValue

public void setPropertyValue(java.lang.String propertyName,
                             java.lang.Object value)
                      throws EClrError

Sets the property value of a specified object using the specified property name.

Specified by:

setPropertyValue in interface IClrBase

Parameters:

propertyName - The string containing the name of the public property to get.

value - The new property value.

Throws:

EClrError

getPropertyIndexValue

public java.lang.Object getPropertyIndexValue(java.lang.String propertyName,
                                              int Index)
                                       throws EClrError

Returns the property value of a specified object with specified property name and index value for indexed properties.

Specified by:

getPropertyIndexValue in interface IClrBase

Parameters:

propertyName - The string containing the name of the public property to get.

Index - Index value for indexed properties. The indexes of indexed properties are zero-based.

Returns:

The property value of the specified object.

Throws:

EClrError

getPropertyIndexValue

public java.lang.Object getPropertyIndexValue(java.lang.String propertyName,
                                              java.lang.String[] typeNames,
                                              java.lang.Object[] indices)
                                       throws EClrError

Searches for the public property with the specified name and returns the property index value of a specified indexer object.

Specified by:

getPropertyIndexValue in interface IClrBase

Parameters:

propertyName - The string containing the name of the public property to get.

typeNames - An array of Type objects names representing the number, order, and type of the parameters for the indexed property to get.

indices - Index values for indexed properties.

Returns:

The property value of the specified object.

Throws:

EClrError

setPropertyIndexValue

public void setPropertyIndexValue(java.lang.String propertyName,
                                  int Index,
                                  java.lang.Object value)
                           throws EClrError

Sets the property value of a specified object with property name andindex value for index properties.

Specified by:

setPropertyIndexValue in interface IClrBase

Parameters:

propertyName - The string containing the name of the public property to get.

Index - Index value for indexed properties.

value - The new property value.

Throws:

EClrError

setPropertyIndexValue

public void setPropertyIndexValue(java.lang.String propertyName,
                                  java.lang.String[] typeNames,
                                  java.lang.Object[] indices,
                                  java.lang.Object value)
                           throws EClrError

Sets the property value of a specified object with optional index values for index properties.

Specified by:

setPropertyIndexValue in interface IClrBase

Parameters:

propertyName - The string containing the name of the public property to get.

typeNames - An array of Type objects names representing the number, order, and type of the parameters for the indexed property to get.

indices - Index values for indexed properties.

value - The new property value.

Throws:

EClrError

invokeVoidMethod

public void invokeVoidMethod(java.lang.String methodName,
                             java.lang.String[] typeNames,
                             java.lang.Object[] parameters)
                      throws EClrError

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

Specified by:

invokeVoidMethod in interface IClrBase

Parameters:

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

typeNames - The names of the method parameter types separated by commas or semi-colon. The names of the parameter types has the same number, order as the parameters of the method to be invoked.

parameters - An argument list for the invoked method. This is an array of objects with the same number, order, and type as the parameters of the method to be invoked.

Throws:

EClrError

invokeMethod

public java.lang.Object invokeMethod(java.lang.String methodName,
                                     java.lang.String[] typeNames,
                                     java.lang.Object[] parameters)
                              throws EClrError

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

Specified by:

invokeMethod in interface IClrBase

Parameters:

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

typeNames - The names of the method parameter types separated by commas or semi-colon. The names of the parameter types has the same number, order as the parameters of the method to be invoked.

parameters - An argument list for the invoked method. This is an array of objects with the same number, order, and type as the parameters of the method to be invoked.

Returns:

Throws:

EClrError

invokeGenericClrObjectMethod

protected DotNetNativeTypes.ClrObject invokeGenericClrObjectMethod(java.lang.String methodName,
                                                                   java.lang.String[] genericTypeNames,
                                                                   java.lang.String[] ParameterTypeNames,
                                                                   java.lang.Object[] parameters)
                                                            throws EClrError

Parameters:

methodName -

genericTypeNames -

ParameterTypeNames -

parameters -

Returns:

Throws:

EClrError

invokeGenericMethod

public java.lang.Object invokeGenericMethod(java.lang.String methodName,
                                            java.lang.String[] genericTypeNames,
                                            java.lang.String[] ParameterTypeNames,
                                            java.lang.Object[] parameters)
                                     throws EClrError

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

Specified by:

invokeGenericMethod in interface IClrBase

Parameters:

methodName - The string containing the name of the public generic 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.

ParameterTypeNames - The names of the method parameter types separated by commas or semi-colon. The names of the parameter types has the same number, order as the parameters of the method to be invoked.

parameters - An argument list for the invoked method. This is an array of objects with the same number, order, and type as the parameters of the method to be invoked.

Returns:

An object containing the return value of the invoked method.

Throws:

EClrError

registerEventCallBack

public void registerEventCallBack(java.lang.String eventName,
                                  DotNetNativeTypes.IClrEventHandler callBack)
                           throws EClrError

Add an event to the current object using the specified event name and function pointer which is the event handler.

Specified by:

registerEventCallBack in interface IClrBase

Parameters:

eventName - The string containing the name of an event that is declared

callBack - Encapsulates a method to be invoked when the event is raised by the current object.

Throws:

EClrError

registerEventCallBackWithReturn

public void registerEventCallBackWithReturn(java.lang.String eventName,
                                            DotNetNativeTypes.IClrEventHandlerReturn callBack)
                                     throws EClrError

Add an event to the current object using the specified event name and function pointer which is the event handler.

Specified by:

registerEventCallBackWithReturn in interface IClrBase

Parameters:

eventName - The string containing the name of an event that is declared

callBack - Encapsulates a method to be invoked when the event is raised by the current object.

Throws:

EClrError

unRegisterEventCallBack

public void unRegisterEventCallBack(java.lang.String eventName,
                                    DotNetNativeTypes.IClrEventHandler callBack)
                             throws EClrError

Remove an event from the current object using the specified event name and function pointer which is the event handler.

Specified by:

unRegisterEventCallBack in interface IClrBase

Parameters:

eventName - The string containing the name of an event that is declared.

callBack - The delegate to be disassociated from the events raised by current object.

Throws:

EClrError

unRegisterEventCallBackWithReturn

public void unRegisterEventCallBackWithReturn(java.lang.String eventName,
                                              DotNetNativeTypes.IClrEventHandlerReturn callBack)
                                       throws EClrError

Remove an event from the current object using the specified event name and function pointer which is the event handler.

Specified by:

unRegisterEventCallBackWithReturn in interface IClrBase

Parameters:

eventName - The string containing the name of an event that is declared.

callBack - The delegate to be disassociated from the events raised by current object.

Throws:

EClrError

clearRef

protected final void clearRef(java.util.Map map,
                              java.lang.Class elementClass)