org.mases.jcobridge

Class JCObject

java.lang.Object

org.mases.jcobridge.JCHandler

org.mases.jcobridge.JCObject

All Implemented Interfaces:

Cloneable, Iterable<JCObject>

public final class JCObject
extends JCHandler
implements Iterable<JCObject>, Cloneable

The JCObject class represents a reflected CLR Object. It implements methods and accessor to interact with a CLR Object.

To instantiate a valid JCObject use JCOBridge.NewObject(java.lang.String, java.lang.Object...) or JCType.NewObject(java.lang.Object...).

Some examples on its use are on https://github.com/masesgroup/JCOReflector

Since:

1.0.0.0

Author:

MASES S.R.L.

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates and returns a copy of this object as per CLR Clone.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one as per CLR Equals.
Object	Get(String propertyName) Retrieve an instance property from the reflected CLR Object.
Object	GetField(String field) Retrieve an instance property from the reflected CLR Object.
Object	GetOnType(String propertyName) Retrieve a property from the reflected CLR Type.
int	hashCode() This method is used to get the CLR hashCode.
Object	Invoke(String method, Object... params) Invokes an instance method on the reflected CLR Object with optional parameters.
Object	InvokeOnType(String method, Object... params) Invokes a method on the reflected CLR Type with optional parameters.
Iterator<JCObject>	iterator() Returns an iterator over elements of type JCObject.
void	RegisterEventListener(String eventName, IJCEventEmit eventHandler) Register an event callback with return value into CLR Object.
void	RegisterEventListener(String eventName, IJCVoidEventEmit eventHandler) Register an event callback without return value into CLR Object.
JCObject	Set(String propertyName, Object value) Sets an instance property on the reflected CLR Object.
JCObject	SetField(String field, Object value) Sets an instance field on the reflected CLR Object.
String	toString() This method is used to get the equivalent CLR ToString.
void	UnregisterEventListener(String eventName, IJCEventEmit eventHandler) Unregister an event callback with return value from CLR Object.
void	UnregisterEventListener(String eventName, IJCVoidEventEmit eventHandler) Unregister an event callback without return value from CLR Object.

Methods inherited from class org.mases.jcobridge.JCHandler

getReference

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

Creates and returns a copy of this object as per CLR Clone.

Overrides:

clone in class Object

Returns:

a clone of this instance.

Throws:

CloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this one as per CLR Equals.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

hashCode

public int hashCode()

This method is used to get the CLR hashCode.

Overrides:

hashCode in class Object

Returns:

the hashcode from the CLR context

toString

public String toString()

This method is used to get the equivalent CLR ToString.

Overrides:

toString in class Object

Returns:

the CLR string representation of this JCObject

iterator

public Iterator<JCObject> iterator()

Returns an iterator over elements of type JCObject.

Specified by:

iterator in interface Iterable<JCObject>

Returns:

an Iterator

Since:

1.0.0.0

Invoke

public Object Invoke(String method,
                     Object... params)
              throws JCNativeException

Invokes an instance method on the reflected CLR Object with optional parameters.

Parameters:

method - The method to be invoked on the CLR Object

params - Optional parameters to pass to the method

Returns:

The result of invoke: it can be a primitive (bool, float, String) or JCObject for all other types

Throws:

JCNativeException - In case of error in the CLR context

Get

public Object Get(String propertyName)
           throws JCNativeException

Retrieve an instance property from the reflected CLR Object.

Parameters:

propertyName - The property to be get from the CLR Object

Returns:

The result of get: it can be a primitive (bool, float, String) or JCObject for all other types

Throws:

JCNativeException - In case of error in the CLR context

GetField

public Object GetField(String field)
                throws JCNativeException

Retrieve an instance property from the reflected CLR Object.

Parameters:

field - The field to be get from the CLR Object

Returns:

The result of get: it can be a primitive (bool, float, String) or JCObject for all other types

Throws:

JCNativeException - In case of error in the CLR context

Set

public JCObject Set(String propertyName,
                    Object value)
             throws JCNativeException

Sets an instance property on the reflected CLR Object.

Parameters:

propertyName - The property to be get from the CLR Object

value - The value to be set

Returns:

The same JCObject for chaining purpose

Throws:

JCNativeException - In case of error in the CLR context

SetField

public JCObject SetField(String field,
                         Object value)
                  throws JCNativeException

Sets an instance field on the reflected CLR Object.

Parameters:

field - The field to be get from the CLR Object

value - The value to be set

Returns:

The same JCObject for chaining purpose

Throws:

JCNativeException - In case of error in the CLR context

InvokeOnType

public Object InvokeOnType(String method,
                           Object... params)
                    throws JCNativeException

Invokes a method on the reflected CLR Type with optional parameters.

Parameters:

method - The method to be invoked on the CLR Type

params - Optional parameters to pass to the method

Returns:

The result of invoke: it can be a primitive (bool, float, String) or JCObject for all other types

Throws:

JCNativeException - In case of error in the CLR context

GetOnType

public Object GetOnType(String propertyName)
                 throws JCNativeException

Retrieve a property from the reflected CLR Type.

Parameters:

propertyName - The property to be get from the CLR Type

Returns:

The result of get: it can be a primitive (bool, float, String) or JCObject for all other types

Throws:

JCNativeException - In case of error in the CLR context

RegisterEventListener

public void RegisterEventListener(String eventName,
                                  IJCVoidEventEmit eventHandler)
                           throws JCNativeException,
                                  JCException

Register an event callback without return value into CLR Object.

Parameters:

eventName - The event to register into the CLR Object

eventHandler - The IJCVoidEventEmit handler instance will receive the event

Throws:

JCNativeException - In case of error in the CLR context

JCException - In case of existing event registered

RegisterEventListener

public void RegisterEventListener(String eventName,
                                  IJCEventEmit eventHandler)
                           throws JCNativeException,
                                  JCException

Register an event callback with return value into CLR Object.

Parameters:

eventName - The event to register into the CLR Object

eventHandler - The IJCEventEmit handler instance will receive the event

Throws:

JCNativeException - In case of error in the CLR context

JCException - In case of existing event registered

UnregisterEventListener

public void UnregisterEventListener(String eventName,
                                    IJCVoidEventEmit eventHandler)
                             throws JCNativeException,
                                    JCException

Unregister an event callback without return value from CLR Object.

Parameters:

eventName - The event to unregister from the CLR Object

eventHandler - The IJCVoidEventEmit handler instance will receive the event

Throws:

JCNativeException - In case of error in the CLR context

JCException - In case of unexisting event registered

UnregisterEventListener

public void UnregisterEventListener(String eventName,
                                    IJCEventEmit eventHandler)
                             throws JCNativeException,
                                    JCException

Unregister an event callback with return value from CLR Object.

Parameters:

eventName - The event to unregister from the CLR Object

eventHandler - The IJCEventEmit handler instance will receive the event

Throws:

JCNativeException - In case of error in the CLR context

JCException - In case of unexisting event registered