com.martinambrus.adminAnything

Enum Reflections

java.lang.Object

java.lang.Enum<Reflections>

com.martinambrus.adminAnything.Reflections

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Reflections>

public enum Reflections
extends java.lang.Enum<Reflections>

A utility class to work with Java's Reflections and allow for ease of use of the GSon library, wherever it is currently located, as it has relocated at least once during all Minecraft's development.

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	getSimpleClass(java.lang.String[] clazzez, java.lang.Object constructorParameter) Receives a list of possible class locations for our target class and an optional constructor parameter (only single parameter classes are supported for now) and returns the actual class from one of the places where it founds it.
static java.lang.reflect.Method	getSimpleMethodFromObjectInstance(java.lang.Object o, java.lang.reflect.Method m, java.lang.String methodName, java.lang.Object methodParameter) Retrieves a simple method (with a single parameter) from the instance of an object.
static void	handleReflectionException(java.lang.Exception e) A very simple error handler for the Reflections utility class.
static Reflections	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Reflections[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static Reflections[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Reflections c : Reflections.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Reflections valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getSimpleClass

public static java.lang.Object getSimpleClass(java.lang.String[] clazzez,
                                              java.lang.Object constructorParameter)

Receives a list of possible class locations for our target class and an optional constructor parameter (only single parameter classes are supported for now) and returns the actual class from one of the places where it founds it.

Example:

 Object gson = Reflections.getSimpleClass(new String[] {
          // mc 1.8+
          "com.google.gson.Gson",
          // mc 1.7
          "net.minecraft.util.com.google.gson.Gson",
          // mc 1.6
          "org.bukkit.craftbukkit.libs.com.google.gson.Gson" }, null);
 

Parameters:

clazzez - List of class locations where to look for a class we need.

constructorParameter - Optional (can be null) constructor parameter. Only single parameter constructors are supported for now.

Returns:

Returns the actual class we wanted or null if it cannot be found in any of the provided locations.

getSimpleMethodFromObjectInstance

public static java.lang.reflect.Method getSimpleMethodFromObjectInstance(java.lang.Object o,
                                                                         java.lang.reflect.Method m,
                                                                         java.lang.String methodName,
                                                                         java.lang.Object methodParameter)

Retrieves a simple method (with a single parameter) from the instance of an object.

Example:

 // this will be null at first
 Method myMethod;

 // try to get a simple, parameter-less method definition
 myMethod = Reflections.getSimpleMethodFromObjectInstance(someObjectInstance, myMethod, "myMethodName", null);

 // here, myMethod would already be defined, so getSimpleMethodFromObjectInstance() would simply
 // return myMethod's value straight away
 myMethod = Reflections.getSimpleMethodFromObjectInstance(someObjectInstance, myMethod, "myMethodName", null);
 

Parameters:

o - The object instance to retrieve the method from.

m - This parameter must be either null or any Method. If a Method is passed as this parameter, then a name check if performed if it's not the same method as we want to retrieve. If it is, we simply return it. Otherwise, Reflection is used and the method is retrieved that way.

methodName - Name of the method we want to retrieve from the given object.

methodParameter - An optional (can be null) parameter for the given method, if multiple method definitions exist with different parameters.

Returns:

Returns the requested method or the same Method (m) as the input if we couldn't find it.

handleReflectionException

public static void handleReflectionException(java.lang.Exception e)

A very simple error handler for the Reflections utility class. Will log an error with the severity of "severe" into the console and print a stack trace.

Parameters:

e - The actual exception to log.