Reflections (CodelanxLib 0.2.0-SNAPSHOT API)

java.lang.Object
- com.codelanx.codelanxlib.util.Reflections

```
public final class Reflections
extends Object
```
Represents utility functions that utilize either java's reflection api, analysis of the current Stack in use, low-level operations, primitives, or other methods that deal with operations outside the norm of Java or Bukkit's own system

Since:

0.1.0

Version:

0.2.0

Author:

1Rogue

Method Summary

All Methods Static Methods Concrete Methods
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 File`	`findPluginJarfile(String name)` Checks whether or not there is a plugin on the server with the name of the passed `name` paramater.
`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 JavaPlugin`	`getCallingPlugin()` Returns the `JavaPlugin` that immediately called the method in the current context.
`static JavaPlugin`	`getCallingPlugin(int offset)` Returns the `JavaPlugin` that immediately called the method in the current context.
`static World`	`getDefaultWorld()` Gets the default `World` loaded by Bukkit
`static 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`
`static Set<String>`	`matchClosestKeys(Map<String,?> map, String search)` Returns a `Set` of keys that closest match the passed in string value
`static <T> List<T>`	`matchClosestValues(Map<String,T> map, String search)` Returns a `List` of values mapped from keys that closest match the passed in string value
`static <T> List<T>`	`nonFixedList(T... items)` Returns a new `ArrayList` of the passed parameters that is not fixed-size, akin to what `Arrays.asList(Object...)` returns
`static <I,R> R`	`nullSafeMutation(I in, Function<I,R> act)` Provides a way of mutating an object (into a new result) without worrying about null safety.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getPlugin
```
public static 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 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 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
  - findPluginJarfile
```
public static File findPluginJarfile(String name)
```
    Checks whether or not there is a plugin on the server with the name of the passed name paramater. This method achieves this by scanning the plugins folder and reading the plugin.yml files of any respective jarfiles in the directory.
    
    Parameters:
    
    name - The name of the plugin as specified in the plugin.yml
    
    Returns:
    
    The File for the plugin jarfile, or null if not found
    
    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
  - matchClosestKeys
```
public static Set<String> matchClosestKeys(Map<String,?> map,
                                           String search)
```
    Returns a Set of keys that closest match the passed in string value
    
    Parameters:
    
    map - The Map with a string key to look through
    
    search - The string to use as a base to search for
    
    Returns:
    
    A list of the closest matching keys, will be empty if no keys begin with the search phrase
    
    Since:
    
    0.1.0
  - matchClosestValues
```
public static <T> List<T> matchClosestValues(Map<String,T> map,
                                             String search)
```
    Returns a List of values mapped from keys that closest match the passed in string value
    
    Type Parameters:
    
    T - The type of the values
    
    Parameters:
    
    map - The Map to look through
    
    search - The string to use as a base to search for
    
    Returns:
    
    A list of the closest matching values, will be empty if no keys begin with the search phrase
    
    Since:
    
    0.1.0
  - nonFixedList
```
public static <T> List<T> nonFixedList(T... items)
```
    Returns a new ArrayList of the passed parameters that is not fixed-size, akin to what Arrays.asList(Object...) returns
    
    Type Parameters:
    
    T - The type of the objects being passed in
    
    Parameters:
    
    items - The parameters to add to a list
    
    Returns:
    
    A new List of the items, or an empty list if no params
    
    Since:
    
    0.1.0
  - getDefaultWorld
```
public static World getDefaultWorld()
```
    Gets the default World loaded by Bukkit
    
    Returns:
    
    Bukkit's default World object
    
    Since:
    
    0.1.0
  - nullSafeMutation
```
public static <I,R> R nullSafeMutation(I in,
                                       Function<I,R> act)
```
    Provides a way of mutating an object (into a new result) without worrying about null safety. This is particularly useful in constructor overloading, where null safety cannot be determined before having to call upon the variable
    
    Type Parameters:
    
    I - The potentially null variable to be mutated
    
    R - The expected result type
    
    Parameters:
    
    in - The variable to evaluate for a mutation
    
    act - The action to take on the variable
    
    Returns:
    
    The expected result
    
    Throws:
    
    IllegalArgumentException - if the passed parameter is null
    
    Since:
    
    0.2.0

Class Reflections

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getPlugin

hasAnnotation

accessedFrom

accessedFrom

accessedFromBukkit

getCallingPlugin

getCallingPlugin

getCaller

getCaller

findPluginJarfile

defaultPrimitiveValue

matchClosestKeys

matchClosestValues

nonFixedList

getDefaultWorld

nullSafeMutation