com.codelanx.codelanxlib.util

Class Reflections

java.lang.Object

com.codelanx.codelanxlib.util.Reflections

public final class Reflections
extends Object

Class description for Reflections

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Method Summary

Modifier and Type	Method and Description
static boolean	accessedFrom(Class<?> clazz) Returns whether or not the current context was called from a class (instance or otherwise) that is passed to this method.
static boolean	accessedFrom(String regex) Returns whether or not the current context was called from a class (instance or otherwise) that is passed to this method.
static boolean	accessedFromBukkit() Façade method for determining if Bukkit is the invoker of the method
static <T> T	defaultPrimitiveValue(Class<T> c) Returns a "default value" of -1 or false for a default type's class or autoboxing class.
static StackTraceElement	getCaller() Returns a StackTraceElement of the direct caller of the current method's context.
static StackTraceElement	getCaller(int offset) Returns a StackTraceElement of the direct caller of the current method's context.
static org.bukkit.plugin.java.JavaPlugin	getCallingPlugin() Returns the JavaPlugin that immediately called the method in the current context.
static org.bukkit.plugin.java.JavaPlugin	getCallingPlugin(int offset) Returns the JavaPlugin that immediately called the method in the current context.
static org.bukkit.plugin.java.JavaPlugin	getPlugin(Class<?> clazz) Returns the relevant JavaPlugin that is specified by a class-level PluginClass annotation if it is loaded, otherwise null
static boolean	hasAnnotation(AnnotatedElement target, Class<? extends Annotation> check) Returns true if the specified target has the passed Annotation

Methods inherited from class java.lang.Object

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

Method Detail

getPlugin

public static org.bukkit.plugin.java.JavaPlugin getPlugin(Class<?> clazz)

Returns the relevant JavaPlugin that is specified by a class-level PluginClass annotation if it is loaded, otherwise null

Parameters:

clazz - The Class that holds the Annotation

Returns:

The relevant JavaPlugin, or null if not found

Since:

0.1.0

hasAnnotation

public static boolean hasAnnotation(AnnotatedElement target,
                                    Class<? extends Annotation> check)

Returns true if the specified target has the passed Annotation

Parameters:

target - The relevant element to check for an Annotation

check - The Annotation class type to check for

Returns:

true if the Annotation is present

Since:

0.1.0

accessedFrom

public static boolean accessedFrom(String regex)

Returns whether or not the current context was called from a class (instance or otherwise) that is passed to this method. This method can match a regex pattern for multiple classes. Note anonymous classes have an empty name.

Parameters:

regex - The regex to check against the calling class

Returns:

true if accessed from a class that matches the regex

Since:

0.1.0

accessedFrom

public static boolean accessedFrom(Class<?> clazz)

Returns whether or not the current context was called from a class (instance or otherwise) that is passed to this method. Note anonymous classes have an empty name.

Parameters:

clazz - The class to check

Returns:

true if accessed from this class

Since:

0.1.0

accessedFromBukkit

public static boolean accessedFromBukkit()

Façade method for determining if Bukkit is the invoker of the method

Returns:

true if Bukkit is the direct invoker of the method

Since:

0.1.0

getCallingPlugin

public static org.bukkit.plugin.java.JavaPlugin getCallingPlugin(int offset)

Returns the JavaPlugin that immediately called the method in the current context. Useful for finding out which plugins accessed static API methods

Parameters:

offset - The number of additional methods to look back

Returns:

The relevant JavaPlugin

Throws:

UnsupportedOperationException - If not called from a JavaPlugin class (either through an alternative ClassLoader, executing code directly, or some voodoo magic)

Since:

0.1.0

getCallingPlugin

public static org.bukkit.plugin.java.JavaPlugin getCallingPlugin()

Returns the JavaPlugin that immediately called the method in the current context. Useful for finding out which plugins accessed static API methods. This method is equivalent to calling Reflections.getCallingPlugin(0)

Returns:

The relevant JavaPlugin

Throws:

UnsupportedOperationException - If not called from a JavaPlugin class (either through an alternative ClassLoader, executing code directly, or some voodoo magic)

Since:

0.1.0

See Also:

getCallingPlugin(int)

getCaller

public static StackTraceElement getCaller(int offset)

Returns a StackTraceElement of the direct caller of the current method's context.

Parameters:

offset - The number of additional methods to look back

Returns:

A StackTraceElement representing where the current context was called from

Since:

0.1.0

getCaller

public static StackTraceElement getCaller()

Returns a StackTraceElement of the direct caller of the current method's context. This method is equivalent to calling Reflections.getCaller(0)

Returns:

A StackTraceElement representing where the current context was called from

Since:

0.1.0

defaultPrimitiveValue

public static <T> T defaultPrimitiveValue(Class<T> c)

Returns a "default value" of -1 or false for a default type's class or autoboxing class. Will return null if not relevant to primitives

Type Parameters:

T - The type of the primitive

Parameters:

c - The primitive class

Returns:

The default value, or null if not a primitive

Since:

0.1.0