Reflections (CodelanxCommons 0.3.2-SNAPSHOT API)

java.lang.Object
- com.codelanx.commons.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 <T> T`	`defaultPrimitiveValue(Class<T> c)` Returns a "default value" of -1 or `false` for a default type's class or autoboxing class.
`static <K,V> Map<K,V>`	`difference(Map<K,V> initial, Map<K,V> replacer)`
`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 Class<?>`	`getArrayClass(Class<?> componentType)`
`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 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.
`static String`	`objectString(Object in)`
`static void`	`operateLock(Lock lock, Runnable operation)` Performs an operation with a lock, saving room by not requiring a lot of `try-finally` blocks
`static <R> R`	`operateLock(Lock lock, Supplier<R> operation)` Performs an operation with a lock, saving room by not requiring a lot of `try-finally` blocks
`static Optional<Byte>`	`parseByte(String s)`
`static Optional<Double>`	`parseDouble(String s)`
`static Optional<Float>`	`parseFloat(String s)`
`static Optional<Integer>`	`parseInt(String s)`
`static Optional<Long>`	`parseLong(String s)`
`static Optional<Short>`	`parseShort(String s)`
`static UUID`	`parseUUID(String uuid)`
`static String`	`properEnumName(Enum<?> val)`
`static String`	`stackTraceToString(Throwable t)` Converts a stack trace into a String for ease-of-use in network-level debugging
`static <T> Stream<T>`	`stream(Iterable<T> itr)` Façade method for streaming `Iterable`, so that Iterable can be accepted as a general parameter
`static <T> Stream<T>`	`stream(T... obj)` Façade method for arrays, to simplify accepting general parameters even further
`static void`	`trace()` Prints out the stack history 10 calls back
`static void`	`trace(int length)` Prints out the stack history `length` calls back

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

- Method Detail
  - 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
  - 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
  - difference
```
public static <K,V> Map<K,V> difference(Map<K,V> initial,
                                        Map<K,V> replacer)
```
  - 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
  - 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
  - operateLock
```
public static void operateLock(Lock lock,
                               Runnable operation)
```
    Performs an operation with a lock, saving room by not requiring a lot of try-finally blocks
    
    Parameters:
    
    lock - The Lock to utilize
    
    operation - The code to be run
    
    Since:
    
    0.2.0
  - operateLock
```
public static <R> R operateLock(Lock lock,
                                Supplier<R> operation)
```
    Performs an operation with a lock, saving room by not requiring a lot of try-finally blocks
    
    Type Parameters:
    
    R - The return type of the Supplier
    
    Parameters:
    
    lock - The Lock to utilize
    
    operation - The code to be run
    
    Returns:
    
    A value returned from the inner Supplier
    
    Since:
    
    0.2.0
  - trace
```
public static void trace()
```
    Prints out the stack history 10 calls back
    
    Since:
    
    0.2.0
  - trace
```
public static void trace(int length)
```
    Prints out the stack history length calls back
    
    Parameters:
    
    length - The number of calls back on the stack to print out
    
    Since:
    
    0.2.0
  - parseUUID
```
public static UUID parseUUID(String uuid)
```
  - objectString
```
public static String objectString(Object in)
```
  - getArrayClass
```
public static Class<?> getArrayClass(Class<?> componentType)
                              throws ClassNotFoundException
```
    Throws:
    
    ClassNotFoundException
  - parseInt
```
public static Optional<Integer> parseInt(String s)
```
  - parseDouble
```
public static Optional<Double> parseDouble(String s)
```
  - parseFloat
```
public static Optional<Float> parseFloat(String s)
```
  - parseShort
```
public static Optional<Short> parseShort(String s)
```
  - parseLong
```
public static Optional<Long> parseLong(String s)
```
  - parseByte
```
public static Optional<Byte> parseByte(String s)
```
  - properEnumName
```
public static String properEnumName(Enum<?> val)
```
  - stream
```
public static <T> Stream<T> stream(Iterable<T> itr)
```
    Façade method for streaming Iterable, so that Iterable can be accepted as a general parameter
    
    Type Parameters:
    
    T - The type of the stream
    
    Parameters:
    
    itr - The Iterable to turn into a stream
    
    Returns:
    
    A Stream of the iterable elements
    
    Since:
    
    0.3.0
  - stream
```
public static <T> Stream<T> stream(T... obj)
```
    Façade method for arrays, to simplify accepting general parameters even further
    
    Type Parameters:
    
    T - The type of the objects and stream
    
    Parameters:
    
    obj - The object(s) to stream
    
    Returns:
    
    A Stream of the iterable elements
    
    Since:
    
    0.3.0
  - stackTraceToString
```
public static String stackTraceToString(Throwable t)
```
    Converts a stack trace into a String for ease-of-use in network-level debugging
    
    Parameters:
    
    t - The Throwable
    
    Returns:
    
    A String form of the exception
    
    Since:
    
    0.3.0

Class Reflections

Method Summary

Methods inherited from class java.lang.Object

Method Detail

hasAnnotation

accessedFrom

accessedFrom

getCaller

getCaller

findPluginJarfile

difference

defaultPrimitiveValue

matchClosestKeys

matchClosestValues

nonFixedList

nullSafeMutation

operateLock

operateLock

trace

trace

parseUUID

objectString

getArrayClass

parseInt

parseDouble

parseFloat

parseShort

parseLong

parseByte

properEnumName

stream

stream

stackTraceToString