reflector

Class Reflector

java.lang.Object

reflector.Reflector

public class Reflector
extends java.lang.Object

Reflector is a master reflection class which the entire bot is built off of. It contains helper functions to make reflection much less of a pain.

Constructor Summary

Constructors

Constructor and Description
Reflector()

Method Summary

Modifier and Type	Method and Description
orsc.OpenRSC	createClient() Creates the RSC client object.
java.lang.Object	getClassMember(java.lang.String className, java.lang.String member) This function will grab the `member` object from the specified `className`.
orsc.mudclient	getMud(orsc.OpenRSC client) Given the OpenRSC client, this function returns the `mudclient`
java.lang.Object	getObjectMember(java.lang.Object obj, java.lang.String member) This function will grab the `member` object from the specified `obj`.
java.lang.Object	getObjectMemberFromSuperclass(java.lang.Object obj, java.lang.String member) Retrieves the member from the given object.
java.lang.Object	mudInvoker(orsc.mudclient mud, java.lang.String methodName, java.lang.Object... params) This function will call `methodName` with `params` inside of `mud`.
void	setObjectMember(java.lang.Object obj, java.lang.String member, java.lang.Object value) Sets the specified member inside of the object to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Reflector

public Reflector()

Method Detail

createClient

public orsc.OpenRSC createClient()

Creates the RSC client object.

Returns:

OpenRSC object

getMud

public orsc.mudclient getMud(orsc.OpenRSC client)

Given the OpenRSC client, this function returns the `mudclient`

Returns:

mudclient

mudInvoker

public java.lang.Object mudInvoker(orsc.mudclient mud,
                                   java.lang.String methodName,
                                   java.lang.Object... params)

This function will call `methodName` with `params` inside of `mud`.

Parameters:

mud - -- the mud object

methodName - -- the method name as a case sensitive string

params - -- parameters, as a list

Returns:

the return value of the specified `methodName` function

getClassMember

public java.lang.Object getClassMember(java.lang.String className,
                                       java.lang.String member)

This function will grab the `member` object from the specified `className`.

*** THIS DOES NOT RECURSE DOWN INTO CHILD OBJECTS. SEE OTHER FUNCTIONS FOR THAT CAPABILITY. ***

Parameters:

className - -- the EXACT name of the class, down to the period. case sensitive.

member - -- the EXACT name of the member of the class. case sensitive.

Returns:

the object requested, or null.

getObjectMember

public java.lang.Object getObjectMember(java.lang.Object obj,
                                        java.lang.String member)

This function will grab the `member` object from the specified `obj`.

*** THIS DOES NOT RECURSE DOWN INTO CHILD OBJECTS. SEE OTHER FUNCTIONS FOR THAT CAPABILITY. ***

Parameters:

obj - -- the object to retrieve data from.

member - -- the EXACT name of the member of the class. case sensitive.

Returns:

the object requested, or null.

getObjectMemberFromSuperclass

public java.lang.Object getObjectMemberFromSuperclass(java.lang.Object obj,
                                                      java.lang.String member)

Retrieves the member from the given object. It WILL work on superclass objects.

Parameters:

obj - -- object to retrieve from

member - -- exact name of the object to return

Returns:

requested object, or null if it does not exist

setObjectMember

public void setObjectMember(java.lang.Object obj,
                            java.lang.String member,
                            java.lang.Object value)

Sets the specified member inside of the object to the specified value.

Parameters:

obj - -- the object to modify

member - -- the member of said object to modify

value - -- the value to set obj.member to.