com.comphenix.protocol.reflect

Class FuzzyReflection

java.lang.Object

com.comphenix.protocol.reflect.FuzzyReflection

public class FuzzyReflection
extends java.lang.Object

Retrieves fields and methods by signature, not just name.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MINECRAFT_OBJECT Matches a Minecraft object.

Constructor Summary

Constructors

Constructor and Description
FuzzyReflection(java.lang.Class<?> source, boolean forceAccess)

Method Summary

Methods

Modifier and Type	Method and Description
static FuzzyReflection	fromClass(java.lang.Class<?> source) Retrieves a fuzzy reflection instance from a given class.
static FuzzyReflection	fromClass(java.lang.Class<?> source, boolean forceAccess) Retrieves a fuzzy reflection instance from a given class.
static FuzzyReflection	fromObject(java.lang.Object reference) Retrieves a fuzzy reflection instance from an object.
static FuzzyReflection	fromObject(java.lang.Object reference, boolean forceAccess) Retrieves a fuzzy reflection instance from an object.
java.lang.reflect.Field	getFieldByName(java.lang.String nameRegex) Retrieves a field by name.
java.lang.reflect.Field	getFieldByType(java.lang.String typeRegex) Retrieves a field by type.
java.lang.reflect.Field	getFieldByType(java.lang.String name, java.lang.Class<?> type) Retrieves the first field with a type equal to or more specific to the given type.
java.lang.reflect.Field	getFieldByType(java.lang.String typeRegex, java.util.Set<java.lang.Class> ignored) Retrieves a field by type.
java.util.List<java.lang.reflect.Field>	getFieldListByType(java.lang.Class<?> type) Retrieves every field with a type equal to or more specific to the given type.
java.util.Set<java.lang.reflect.Field>	getFields() Retrieves all private and public fields in declared order (after JDK 1.5).
java.lang.reflect.Method	getMethodByName(java.lang.String nameRegex) Retrieves a method by looking at its name.
java.lang.reflect.Method	getMethodByParameters(java.lang.String name, java.lang.Class<?>... args) Retrieves a method by looking at the parameter types only.
java.lang.reflect.Method	getMethodByParameters(java.lang.String name, java.lang.Class<?> returnType, java.lang.Class<?>[] args) Retrieves a method by looking at the parameter types and return type only.
java.lang.reflect.Method	getMethodByParameters(java.lang.String name, java.lang.String returnTypeRegex, java.lang.String[] argsRegex) Retrieves a method by looking at the parameter types and return type only.
java.util.List<java.lang.reflect.Method>	getMethodListByParameters(java.lang.Class<?> returnType, java.lang.Class<?>[] args) Retrieves every method that has the given parameter types and return type.
java.util.Set<java.lang.reflect.Method>	getMethods() Retrieves all private and public methods in declared order (after JDK 1.5).
java.lang.Class<?>	getSource() Retrieves the underlying class.
boolean	isForceAccess() Retrieves whether or not not to override any scope restrictions.
void	setForceAccess(boolean forceAccess) Sets whether or not not to override any scope restrictions.

Methods inherited from class java.lang.Object

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

Field Detail

MINECRAFT_OBJECT

public static final java.lang.String MINECRAFT_OBJECT

Matches a Minecraft object.

See Also:

Constant Field Values

Constructor Detail

FuzzyReflection

public FuzzyReflection(java.lang.Class<?> source,
               boolean forceAccess)

Method Detail

fromClass

public static FuzzyReflection fromClass(java.lang.Class<?> source)

Retrieves a fuzzy reflection instance from a given class.

Parameters:

source - - the class we'll use.

Returns:

A fuzzy reflection instance.

fromClass

public static FuzzyReflection fromClass(java.lang.Class<?> source,
                        boolean forceAccess)

Retrieves a fuzzy reflection instance from a given class.

Parameters:

source - - the class we'll use.

forceAccess - - whether or not to override scope restrictions.

Returns:

A fuzzy reflection instance.

fromObject

public static FuzzyReflection fromObject(java.lang.Object reference)

Retrieves a fuzzy reflection instance from an object.

Parameters:

reference - - the object we'll use.

Returns:

A fuzzy reflection instance that uses the class of the given object.

fromObject

public static FuzzyReflection fromObject(java.lang.Object reference,
                         boolean forceAccess)

Retrieves a fuzzy reflection instance from an object.

Parameters:

reference - - the object we'll use.

forceAccess - - whether or not to override scope restrictions.

Returns:

A fuzzy reflection instance that uses the class of the given object.

getSource

public java.lang.Class<?> getSource()

Retrieves the underlying class.

getMethodByName

public java.lang.reflect.Method getMethodByName(java.lang.String nameRegex)

Retrieves a method by looking at its name.

Parameters:

nameRegex - - regular expression that will match method names.

Returns:

The first method that satisfies the regular expression.

Throws:

java.lang.IllegalArgumentException - If the method cannot be found.

getMethodByParameters

public java.lang.reflect.Method getMethodByParameters(java.lang.String name,
                                             java.lang.Class<?>... args)

Retrieves a method by looking at the parameter types only.

Parameters:

name - - potential name of the method. Only used by the error mechanism.

args - - parameter types of the method to find.

Returns:

The first method that satisfies the parameter types.

Throws:

java.lang.IllegalArgumentException - If the method cannot be found.

getMethodByParameters

public java.lang.reflect.Method getMethodByParameters(java.lang.String name,
                                             java.lang.Class<?> returnType,
                                             java.lang.Class<?>[] args)

Retrieves a method by looking at the parameter types and return type only.

Parameters:

name - - potential name of the method. Only used by the error mechanism.

returnType - - return type of the method to find.

args - - parameter types of the method to find.

Returns:

The first method that satisfies the parameter types.

Throws:

java.lang.IllegalArgumentException - If the method cannot be found.

getMethodByParameters

public java.lang.reflect.Method getMethodByParameters(java.lang.String name,
                                             java.lang.String returnTypeRegex,
                                             java.lang.String[] argsRegex)

Retrieves a method by looking at the parameter types and return type only.

Parameters:

name - - potential name of the method. Only used by the error mechanism.

returnTypeRegex - - regular expression matching the return type of the method to find.

argsRegex - - regular expressions of the matching parameter types.

Returns:

The first method that satisfies the parameter types.

Throws:

java.lang.IllegalArgumentException - If the method cannot be found.

getMethodListByParameters

public java.util.List<java.lang.reflect.Method> getMethodListByParameters(java.lang.Class<?> returnType,
                                                                 java.lang.Class<?>[] args)

Retrieves every method that has the given parameter types and return type.

Parameters:

returnType - - return type of the method to find.

args - - parameter types of the method to find.

Returns:

Every method that satisfies the given constraints.

getFieldByName

public java.lang.reflect.Field getFieldByName(java.lang.String nameRegex)

Retrieves a field by name.

Parameters:

nameRegex - - regular expression that will match a field name.

Returns:

The first field to match the given expression.

Throws:

java.lang.IllegalArgumentException - If the field cannot be found.

getFieldByType

public java.lang.reflect.Field getFieldByType(java.lang.String name,
                                     java.lang.Class<?> type)

Retrieves the first field with a type equal to or more specific to the given type.

Parameters:

name - - name the field probably is given. This will only be used in the error message.

type - - type of the field to find.

Returns:

The first field with a type that is an instance of the given type.

getFieldListByType

public java.util.List<java.lang.reflect.Field> getFieldListByType(java.lang.Class<?> type)

Retrieves every field with a type equal to or more specific to the given type.

Parameters:

type - - type of the fields to find.

Returns:

Every field with a type that is an instance of the given type.

getFieldByType

public java.lang.reflect.Field getFieldByType(java.lang.String typeRegex)

Retrieves a field by type.

Note that the type is matched using the full canonical representation, i.e.:

• java.util.List
• net.comphenix.xp.ExperienceMod

Parameters:

typeRegex - - regular expression that will match the field type.

Returns:

The first field with a type that matches the given regular expression.

Throws:

java.lang.IllegalArgumentException - If the field cannot be found.

getFieldByType

public java.lang.reflect.Field getFieldByType(java.lang.String typeRegex,
                                     java.util.Set<java.lang.Class> ignored)

Retrieves a field by type.

Note that the type is matched using the full canonical representation, i.e.:

• java.util.List
• net.comphenix.xp.ExperienceMod

Parameters:

typeRegex - - regular expression that will match the field type.

ignored - - types to ignore.

Returns:

The first field with a type that matches the given regular expression.

Throws:

java.lang.IllegalArgumentException - If the field cannot be found.

getFields

public java.util.Set<java.lang.reflect.Field> getFields()

Retrieves all private and public fields in declared order (after JDK 1.5).

Returns:

Every field.

getMethods

public java.util.Set<java.lang.reflect.Method> getMethods()

Retrieves all private and public methods in declared order (after JDK 1.5).

Returns:

Every method.

isForceAccess

public boolean isForceAccess()

Retrieves whether or not not to override any scope restrictions.

Returns:

TRUE if we override scope, FALSE otherwise.

setForceAccess

public void setForceAccess(boolean forceAccess)

Sets whether or not not to override any scope restrictions.

Parameters:

forceAccess - - TRUE if we override scope, FALSE otherwise.