org.apache.brooklyn.util.javalang

Class Reflections

java.lang.Object

org.apache.brooklyn.util.javalang.Reflections

public class Reflections
extends java.lang.Object

Reflection utilities

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Reflections.ReflectionAccessException
static class	Reflections.ReflectionNotFoundException

Constructor Summary

Constructors

Constructor and Description
Reflections(java.lang.ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
Reflections	applyClassRenames(java.util.Map<java.lang.String,java.lang.String> newClassRenames) supply a map of known renames, of the form "old-class -> new-class"
static java.util.List<?>	arrayToList(java.lang.Object input)
static <T> T	cast(java.lang.Object candidate, java.lang.Class<? extends T> type) convenience for casting the given candidate to the given type (without any coercion, and allowing candidate to be null)
static <T> void	copyFields(T source, T target) copies all fields from the source to target; very little compile-time safety checking, so use with care
static Maybe<java.lang.reflect.Method>	findAccessibleMethod(java.lang.reflect.Method method) Attempts to find an equivalent accessible method to be invoked (or if the given method is already accessible, then return it).
static java.lang.reflect.Field	findField(java.lang.Class<?> clazz, java.lang.String name) Finds the field with the given name declared on the given class or any superclass, using Class.getDeclaredField(String).
static Maybe<java.lang.reflect.Field>	findFieldMaybe(java.lang.Class<?> clazz, java.lang.String originalName)
static java.util.List<java.lang.reflect.Field>	findFields(java.lang.Class<?> clazz, <any> filter, java.util.Comparator<java.lang.reflect.Field> fieldOrdering) Lists all fields declared on the class, with those lowest in the hierarchy first, filtered and ordered as requested.
static java.lang.String	findMappedNameAndLog(java.util.Map<java.lang.String,java.lang.String> renames, java.lang.String name)
static Maybe<java.lang.String>	findMappedNameMaybe(java.util.Map<java.lang.String,java.lang.String> renames, java.lang.String name) Takes a map of old-class-names to renames classes, and returns the mapped name if matched, or absent
static java.lang.reflect.Method	findMethod(java.lang.Class<?> clazz, java.lang.String name, java.lang.Class<?>... parameterTypes) Deprecated. since 0.10.0 use findMethodMaybe(Class, String, Class...) or findMethodsCompatible(Class, String, Class...)
static Maybe<java.lang.reflect.Method>	findMethodMaybe(java.lang.Class<?> clazz, java.lang.String name, java.lang.Class<?>... parameterTypes) Returns any method exactly matching the given signature, including privates and on parent classes.
static java.lang.Iterable<java.lang.reflect.Method>	findMethodsCompatible(java.lang.Class<?> clazz, java.lang.String name, java.lang.Class<?>... parameterTypes) Returns all methods compatible with the given argument types, including privates and on parent classes and where the method takes a supertype.
static java.util.List<java.lang.reflect.Field>	findPublicFieldsOrderedBySuper(java.lang.Class<?> clazz) Lists all public fields declared on the class or any ancestor, with those HIGHEST in the hierarchy first
static java.util.List<java.lang.reflect.Method>	findPublicMethodsOrderedBySuper(java.lang.Class<?> clazz)
static <T> java.lang.Class<? super T>	findSuperType(T impl, java.lang.String typeName)
static java.util.List<java.lang.Class<?>>	getAllInterfaces(java.lang.Class<?> type) Gets all the interfaces implemented by the given type, including its parent classes.
java.lang.ClassLoader	getClassLoader()
static Maybe<java.lang.Object>	getFieldValueMaybe(java.lang.Object instance, java.lang.reflect.Field field)
static Maybe<java.lang.Object>	getFieldValueMaybe(java.lang.Object instance, java.lang.String fieldName)
static <any>[]	getGenericParameterTypeTokens(<any> t)
static java.util.Set<java.lang.Class<?>>	getInterfacesIncludingClassAncestors(java.lang.Class<?> clazz) whereas Class.getInterfaces() only returns interfaces directly implemented by a class, this walks the inheritance hierarchy to include interfaces implemented by superclass/ancestors; (note it does not include superinterfaces)
static Maybe<java.lang.reflect.Method>	getMethodFromArgs(java.lang.Object clazzOrInstance, java.lang.String method, java.util.List<?> args) searches for the given method on the given clazz or instance, doing reasonably good matching on args etc
static Maybe<java.lang.reflect.Method>	getMethodFromArgs(java.lang.Object clazzOrInstance, java.lang.String method, java.util.List<?> args, <any> coercer) searches for the given method on the given clazz or instance, doing reasonably good matching on args etc
java.net.URL	getResource(java.lang.String r) finds the resource in the classloader, if it exists; inserts or replaces leading slash as necessary (i believe it should _not_ have one, but there is some inconsistency) Will return null if no resource is found.
static boolean	hasNoArgConstructor(java.lang.Class<?> clazz)
static boolean	hasNoNonObjectFields(java.lang.Class<? extends java.lang.Object> clazz)
static boolean	hasSpecialSerializationMethods(java.lang.Class<? extends java.lang.Object> type)
static java.lang.Class<?>	inferSubbest(java.lang.Class<?> c1, java.lang.Class<?> c2) If one class is a subclass of the other, return that (the lower in the type hierarchy); otherwise return null (if they are the same or neither is a subclass of the other).
static java.lang.reflect.Field	inferSubbestField(java.lang.reflect.Field f1, java.lang.reflect.Field f2) If the classes of the fields satisfy inferSubbest(Class, Class) return the field in the lower (sub-best) class, otherwise null.
static java.lang.reflect.Method	inferSubbestMethod(java.lang.reflect.Method m1, java.lang.reflect.Method m2) If the classes of the methods satisfy inferSubbest(Class, Class) return the field in the lower (sub-best) class, otherwise null.
static <T> Maybe<T>	invokeConstructorFromArgs(java.lang.Class<? extends T> clazz, java.lang.Object... argsArray) Finds and invokes a suitable constructor, supporting varargs and primitives, boxing and looking at compatible supertypes in the constructor's signature
static <T> Maybe<T>	invokeConstructorFromArgs(java.lang.Class<? extends T> clazz, java.lang.Object[] argsArray, boolean setAccessible) As invokeConstructorFromArgs(Class, Object...) but allowing more configurable input; in particular setAccessible allows private constructors to be used (not the default)
static <T> Maybe<T>	invokeConstructorFromArgs(java.lang.ClassLoader classLoader, java.lang.Class<T> clazz, java.lang.Object[] argsArray, boolean setAccessible) As invokeConstructorFromArgs(Class, Object...) but allowing more configurable input; in particular setAccessible allows private constructors to be used (not the default)
static <T> Maybe<T>	invokeConstructorFromArgs(java.lang.ClassLoader classLoader, java.lang.Class<T> optionalSupertype, java.lang.String className, java.lang.Object... argsArray) Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead
static Maybe<java.lang.Object>	invokeConstructorFromArgs(java.lang.ClassLoader classLoader, java.lang.String className, java.lang.Object... argsArray) Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead
static <T> Maybe<T>	invokeConstructorFromArgs(Reflections reflections, java.lang.Class<? extends T> clazz, java.lang.Object[] argsArray, boolean setAccessible) As invokeConstructorFromArgs(Class, Object...) but allowing more configurable input; in particular setAccessible allows private constructors to be used (not the default)
static <T> Maybe<T>	invokeConstructorFromArgsIncludingPrivate(java.lang.Class<? extends T> clazz, java.lang.Object... argsArray) As invokeConstructorFromArgs(Class, Object...) but will use private constructors (with setAccessible = true)
static <T> Maybe<T>	invokeConstructorFromArgsUntyped(java.lang.ClassLoader classLoader, java.lang.String className, java.lang.Object... argsArray) Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead
static <T> <any>	invokeConstructorWithArgs(java.lang.Class<? extends T> clazz, java.lang.Object... argsArray) Deprecated. since 0.10.0 use invokeConstructorFromArgs(Class, Object...) or one of the variants
static <T> <any>	invokeConstructorWithArgs(java.lang.Class<? extends T> clazz, java.lang.Object[] argsArray, boolean setAccessible) Deprecated. since 0.10.0 use invokeConstructorFromArgs(Class, Object...) or one of the variants
static <T> <any>	invokeConstructorWithArgs(java.lang.ClassLoader classLoader, java.lang.Class<T> clazz, java.lang.Object[] argsArray, boolean setAccessible) Deprecated. since 0.10.0 use invokeConstructorFromArgs(Class, Object...) or one of the variants
static <T> <any>	invokeConstructorWithArgs(java.lang.ClassLoader classLoader, java.lang.String className, java.lang.Object... argsArray) Deprecated. since 0.10.0 use invokeConstructorFromArgs(Class, Object...) or one of the variants; this allows null field values
static <T> <any>	invokeConstructorWithArgs(Reflections reflections, java.lang.Class<? extends T> clazz, java.lang.Object[] argsArray, boolean setAccessible) Deprecated. since 0.10.0 use invokeConstructorFromArgs(Class, Object...) or one of the variants
java.lang.Object	invokeMethod(java.lang.reflect.Method method, java.lang.Object obj, java.lang.Object... argValues)
static java.lang.Object	invokeMethodFromArgs(java.lang.Object clazzOrInstance, java.lang.reflect.Method m, java.util.List<?> args) invokes the given method on the given clazz or instance, assuming that the method matches passed arguments
static java.lang.Object	invokeMethodFromArgs(java.lang.Object clazzOrInstance, java.lang.reflect.Method m, java.util.List<?> args, boolean setAccessible) as invokeMethodFromArgs(Object, Method, List) but giving control over whether to set it accessible
static java.lang.Object	invokeMethodFromArgs(java.lang.Object clazzOrInstance, java.lang.reflect.Method m, java.util.List<?> args, boolean setAccessible, <any> coercer) as invokeMethodFromArgs(Object, Method, List) but giving control over whether to set it accessible
static Maybe<java.lang.Object>	invokeMethodFromArgs(java.lang.Object clazzOrInstance, java.lang.String method, java.util.List<?> args) invokes the given method on the given clazz or instance, doing reasonably good matching on args etc
static Maybe<java.lang.Object>	invokeMethodFromArgs(java.lang.Object clazzOrInstance, java.lang.String method, java.util.List<?> args, boolean setAccessible) as invokeMethodFromArgs(Object, String, List) but giving control over whether to set it accessible
static Maybe<java.lang.Object>	invokeMethodFromArgs(java.lang.Object clazzOrInstance, java.lang.String method, java.util.List<?> args, boolean setAccessible, <any> coercer) as invokeMethodFromArgs(Object, String, List) but giving control over whether to set it accessible
static <any>	invokeMethodWithArgs(java.lang.Object clazzOrInstance, java.lang.String method, java.util.List<?> args) Deprecated. since 0.10.0 use invokeMethodFromArgs(Object, String, List); this allows null return values
static <any>	invokeMethodWithArgs(java.lang.Object clazzOrInstance, java.lang.String method, java.util.List<?> args, boolean setAccessible) Deprecated. since 0.10.0 use invokeMethodFromArgs(Object, String, List)
java.lang.Object	invokeStaticMethod(java.lang.reflect.Method method, java.lang.Object... argValues)
java.lang.Class<?>	loadClass(java.lang.String classname) Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead
<T> java.lang.Class<? extends T>	loadClass(java.lang.String classname, java.lang.Class<T> superType) Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead
java.lang.Class<?>	loadClassFromCanonicalName(java.lang.String canonicalName) Loads class given its canonical name format (e.g.
java.lang.reflect.Constructor<?>	loadConstructor(java.lang.Class<?> clazz, java.lang.Class<?>[] argTypes)
java.lang.Class<?>	loadInnerClassNotInheritted(java.lang.Class<?> outerClazz, java.lang.String innerClassname) does not look through ancestors of outer class
java.lang.Class<?>	loadInnerClassNotInheritted(java.lang.String outerClassname, java.lang.String innerClassname) Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead
static java.lang.Class<?>	loadInnerClassPossiblyInheritted(java.lang.Class<?> clazz, java.lang.String nestedPart) given a nested part, e.g.
<T> T	loadInstance(java.lang.reflect.Constructor<T> constructor, java.lang.Object... argValues)
java.lang.Object	loadInstance(java.lang.String classname) Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead
java.lang.Object	loadInstance(java.lang.String classname, java.lang.Class<?>[] argTypes, java.lang.Object[] argValues) Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead
java.lang.Object	loadInstance(java.lang.String classname, java.lang.Object... argValues) Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead
java.lang.reflect.Method	loadMethod(java.lang.Class<?> clazz, java.lang.String methodName) returns the first method matching the given name
java.lang.reflect.Method	loadMethod(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Class<?>[] argTypes)
java.lang.reflect.Constructor<?>	loadSingleConstructor(java.lang.Class<?> clazz) returns a single constructor in a given class, or throws an exception
java.lang.Object	loadStaticField(java.lang.Class<?> clazz, java.lang.String fieldname)
java.lang.Object[]	loadStaticFields(java.lang.Class<?> clazz, java.lang.String[] fieldnamesArray, java.lang.Object[] defaults)
static <any>	tryFindMappedName(java.util.Map<java.lang.String,java.lang.String> renames, java.lang.String name) Deprecated. since 0.10.0 use findMappedNameMaybe(Map, String)
static boolean	trySetAccessible(java.lang.reflect.Method method) Calls AccessibleObject.setAccessible(boolean) "safely", wrapping in a try-catch block so that the exception is never propagated.
static boolean	typeMatches(java.lang.Object arg, java.lang.Class<?> parameterType, <any> coercer) true iff the initial N args match the corresponding types
static boolean	typesMatch(java.lang.Object[] argsArray, java.lang.Class<?>[] parameterTypes) true iff all args match the corresponding types
static boolean	typesMatch(java.lang.Object[] argsArray, java.lang.Class<?>[] parameterTypes, <any> coercer) true iff all args match the corresponding types
static boolean	typesMatchUpTo(java.lang.Object[] argsArray, java.lang.Class<?>[] parameterTypes, int lengthRequired) true iff the initial N args match the corresponding types
static boolean	typesMatchUpTo(java.lang.Object[] argsArray, java.lang.Class<?>[] parameterTypes, int lengthRequired, <any> coercer) true iff the initial N args match the corresponding types
java.lang.Object	updateFromNewClassLoader(java.lang.Object data) Serialize the given object, then reload using the current class loader; this removes linkages to instances with classes loaded by an older class loader.

Methods inherited from class java.lang.Object

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

Constructor Detail

Reflections

public Reflections(java.lang.ClassLoader classLoader)

Method Detail

applyClassRenames

public Reflections applyClassRenames(java.util.Map<java.lang.String,java.lang.String> newClassRenames)

supply a map of known renames, of the form "old-class -> new-class"

loadInstance

public java.lang.Object loadInstance(java.lang.String classname,
                                     java.lang.Object... argValues)
                              throws Reflections.ReflectionNotFoundException,
                                     Reflections.ReflectionAccessException

Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead

Throws:

Reflections.ReflectionNotFoundException

Reflections.ReflectionAccessException

loadInstance

public java.lang.Object loadInstance(java.lang.String classname,
                                     java.lang.Class<?>[] argTypes,
                                     java.lang.Object[] argValues)
                              throws Reflections.ReflectionNotFoundException,
                                     Reflections.ReflectionAccessException

Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead

Throws:

Reflections.ReflectionNotFoundException

Reflections.ReflectionAccessException

loadInstance

public java.lang.Object loadInstance(java.lang.String classname)
                              throws Reflections.ReflectionNotFoundException,
                                     Reflections.ReflectionAccessException

Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead

Throws:

Reflections.ReflectionNotFoundException

Reflections.ReflectionAccessException

loadClass

public java.lang.Class<?> loadClass(java.lang.String classname)
                             throws Reflections.ReflectionNotFoundException

Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead

Throws:

Reflections.ReflectionNotFoundException

loadClass

public <T> java.lang.Class<? extends T> loadClass(java.lang.String classname,
                                                  java.lang.Class<T> superType)
                                           throws Reflections.ReflectionNotFoundException

Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead

Throws:

Reflections.ReflectionNotFoundException

loadInnerClassPossiblyInheritted

public static java.lang.Class<?> loadInnerClassPossiblyInheritted(java.lang.Class<?> clazz,
                                                                  java.lang.String nestedPart)
                                                           throws Reflections.ReflectionNotFoundException

given a nested part, e.g. Inner$VeryInner, this will recurse through clazz.Inner, looking for VeryInner, then looking in each supertype (interface) of clazz for Inner.VeryInner;

so it will find Clazz.Inner.VeryInner wherever in the hierarchy it is defined

(as opposed to ClassLoader which requires Inner.VeryInner to be _declared_ in clazz, not in any supertype

returns null if not found

Throws:

Reflections.ReflectionNotFoundException

loadInnerClassNotInheritted

public java.lang.Class<?> loadInnerClassNotInheritted(java.lang.String outerClassname,
                                                      java.lang.String innerClassname)
                                               throws Reflections.ReflectionNotFoundException

Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead

Throws:

Reflections.ReflectionNotFoundException

loadInnerClassNotInheritted

public java.lang.Class<?> loadInnerClassNotInheritted(java.lang.Class<?> outerClazz,
                                                      java.lang.String innerClassname)
                                               throws Reflections.ReflectionNotFoundException

does not look through ancestors of outer class

uses the classloader set in this class, not in the clazz supplied

Throws:

Reflections.ReflectionNotFoundException

loadConstructor

public java.lang.reflect.Constructor<?> loadConstructor(java.lang.Class<?> clazz,
                                                        java.lang.Class<?>[] argTypes)
                                                 throws Reflections.ReflectionAccessException

Throws:

Reflections.ReflectionAccessException

invokeConstructorWithArgs

@Deprecated
public static <T> <any> invokeConstructorWithArgs(java.lang.ClassLoader classLoader,
                                                              java.lang.String className,
                                                              java.lang.Object... argsArray)

Deprecated. since 0.10.0 use invokeConstructorFromArgs(Class, Object...) or one of the variants; this allows null field values

invokeConstructorWithArgs

@Deprecated
public static <T> <any> invokeConstructorWithArgs(java.lang.ClassLoader classLoader,
                                                              java.lang.Class<T> clazz,
                                                              java.lang.Object[] argsArray,
                                                              boolean setAccessible)

Deprecated. since 0.10.0 use invokeConstructorFromArgs(Class, Object...) or one of the variants

invokeConstructorWithArgs

@Deprecated
public static <T> <any> invokeConstructorWithArgs(java.lang.Class<? extends T> clazz,
                                                              java.lang.Object... argsArray)

Deprecated. since 0.10.0 use invokeConstructorFromArgs(Class, Object...) or one of the variants

invokeConstructorWithArgs

@Deprecated
public static <T> <any> invokeConstructorWithArgs(java.lang.Class<? extends T> clazz,
                                                              java.lang.Object[] argsArray,
                                                              boolean setAccessible)

Deprecated. since 0.10.0 use invokeConstructorFromArgs(Class, Object...) or one of the variants

invokeConstructorWithArgs

@Deprecated
public static <T> <any> invokeConstructorWithArgs(Reflections reflections,
                                                              java.lang.Class<? extends T> clazz,
                                                              java.lang.Object[] argsArray,
                                                              boolean setAccessible)

Deprecated. since 0.10.0 use invokeConstructorFromArgs(Class, Object...) or one of the variants

invokeConstructorFromArgs

public static <T> Maybe<T> invokeConstructorFromArgs(java.lang.Class<? extends T> clazz,
                                                     java.lang.Object... argsArray)

Finds and invokes a suitable constructor, supporting varargs and primitives, boxing and looking at compatible supertypes in the constructor's signature

invokeConstructorFromArgs

public static Maybe<java.lang.Object> invokeConstructorFromArgs(java.lang.ClassLoader classLoader,
                                                                java.lang.String className,
                                                                java.lang.Object... argsArray)

Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead

invokeConstructorFromArgs

public static <T> Maybe<T> invokeConstructorFromArgs(java.lang.ClassLoader classLoader,
                                                     java.lang.Class<T> optionalSupertype,
                                                     java.lang.String className,
                                                     java.lang.Object... argsArray)

Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead

invokeConstructorFromArgsUntyped

public static <T> Maybe<T> invokeConstructorFromArgsUntyped(java.lang.ClassLoader classLoader,
                                                            java.lang.String className,
                                                            java.lang.Object... argsArray)

Deprecated. since 0.11.0, use ClassLoaderUtils in a combination with invokeConstructorFromArgs(Class, Object...) instead

invokeConstructorFromArgs

public static <T> Maybe<T> invokeConstructorFromArgs(java.lang.ClassLoader classLoader,
                                                     java.lang.Class<T> clazz,
                                                     java.lang.Object[] argsArray,
                                                     boolean setAccessible)

As invokeConstructorFromArgs(Class, Object...) but allowing more configurable input; in particular setAccessible allows private constructors to be used (not the default)

invokeConstructorFromArgs

public static <T> Maybe<T> invokeConstructorFromArgs(java.lang.Class<? extends T> clazz,
                                                     java.lang.Object[] argsArray,
                                                     boolean setAccessible)

As invokeConstructorFromArgs(Class, Object...) but allowing more configurable input; in particular setAccessible allows private constructors to be used (not the default)

invokeConstructorFromArgsIncludingPrivate

public static <T> Maybe<T> invokeConstructorFromArgsIncludingPrivate(java.lang.Class<? extends T> clazz,
                                                                     java.lang.Object... argsArray)

As invokeConstructorFromArgs(Class, Object...) but will use private constructors (with setAccessible = true)

invokeConstructorFromArgs

public static <T> Maybe<T> invokeConstructorFromArgs(Reflections reflections,
                                                     java.lang.Class<? extends T> clazz,
                                                     java.lang.Object[] argsArray,
                                                     boolean setAccessible)

As invokeConstructorFromArgs(Class, Object...) but allowing more configurable input; in particular setAccessible allows private constructors to be used (not the default)

loadSingleConstructor

public java.lang.reflect.Constructor<?> loadSingleConstructor(java.lang.Class<?> clazz)

returns a single constructor in a given class, or throws an exception

loadInstance

public <T> T loadInstance(java.lang.reflect.Constructor<T> constructor,
                          java.lang.Object... argValues)
                   throws java.lang.IllegalArgumentException,
                          Reflections.ReflectionAccessException

Throws:

java.lang.IllegalArgumentException

Reflections.ReflectionAccessException

loadMethod

public java.lang.reflect.Method loadMethod(java.lang.Class<?> clazz,
                                           java.lang.String methodName,
                                           java.lang.Class<?>[] argTypes)
                                    throws Reflections.ReflectionNotFoundException,
                                           Reflections.ReflectionAccessException

Throws:

Reflections.ReflectionNotFoundException

Reflections.ReflectionAccessException

loadMethod

public java.lang.reflect.Method loadMethod(java.lang.Class<?> clazz,
                                           java.lang.String methodName)
                                    throws Reflections.ReflectionNotFoundException,
                                           Reflections.ReflectionAccessException

returns the first method matching the given name

Throws:

Reflections.ReflectionNotFoundException

Reflections.ReflectionAccessException

invokeMethod

public java.lang.Object invokeMethod(java.lang.reflect.Method method,
                                     java.lang.Object obj,
                                     java.lang.Object... argValues)
                              throws Reflections.ReflectionAccessException

Throws:

Reflections.ReflectionAccessException - If invocation failed due to illegal access or the invoked method failed

java.lang.IllegalArgumentException - If the arguments were invalid

invokeStaticMethod

public java.lang.Object invokeStaticMethod(java.lang.reflect.Method method,
                                           java.lang.Object... argValues)
                                    throws java.lang.IllegalArgumentException,
                                           Reflections.ReflectionAccessException

Throws:

java.lang.IllegalArgumentException

Reflections.ReflectionAccessException

loadStaticField

public java.lang.Object loadStaticField(java.lang.Class<?> clazz,
                                        java.lang.String fieldname)
                                 throws Reflections.ReflectionAccessException

Throws:

Reflections.ReflectionAccessException

loadStaticFields

public java.lang.Object[] loadStaticFields(java.lang.Class<?> clazz,
                                           java.lang.String[] fieldnamesArray,
                                           java.lang.Object[] defaults)
                                    throws Reflections.ReflectionAccessException

Throws:

Reflections.ReflectionAccessException

copyFields

public static <T> void copyFields(T source,
                                  T target)
                           throws java.lang.IllegalArgumentException,
                                  java.lang.IllegalAccessException

copies all fields from the source to target; very little compile-time safety checking, so use with care

Throws:

java.lang.IllegalAccessException

java.lang.IllegalArgumentException

loadClassFromCanonicalName

public java.lang.Class<?> loadClassFromCanonicalName(java.lang.String canonicalName)
                                              throws java.lang.ClassNotFoundException,
                                                     Reflections.ReflectionNotFoundException

Loads class given its canonical name format (e.g. com.acme.Foo.Inner), using iterative strategy (trying com.acme.Foo$Inner, then com.acme$Foo$Inner, etc).

Throws:

Reflections.ReflectionNotFoundException

java.lang.ClassNotFoundException

getResource

@Nullable
public java.net.URL getResource(java.lang.String r)

finds the resource in the classloader, if it exists; inserts or replaces leading slash as necessary (i believe it should _not_ have one, but there is some inconsistency) Will return null if no resource is found.

updateFromNewClassLoader

public final java.lang.Object updateFromNewClassLoader(java.lang.Object data)
                                                throws java.io.IOException,
                                                       java.lang.ClassNotFoundException

Serialize the given object, then reload using the current class loader; this removes linkages to instances with classes loaded by an older class loader.

(like a poor man's clone)

aka "reconstitute(Object)"

Throws:

java.io.IOException

java.lang.ClassNotFoundException

getClassLoader

public java.lang.ClassLoader getClassLoader()

findSuperType

public static <T> java.lang.Class<? super T> findSuperType(T impl,
                                                           java.lang.String typeName)

getInterfacesIncludingClassAncestors

public static java.util.Set<java.lang.Class<?>> getInterfacesIncludingClassAncestors(java.lang.Class<?> clazz)

whereas Class.getInterfaces() only returns interfaces directly implemented by a class, this walks the inheritance hierarchy to include interfaces implemented by superclass/ancestors; (note it does not include superinterfaces)

findMethodMaybe

public static Maybe<java.lang.reflect.Method> findMethodMaybe(java.lang.Class<?> clazz,
                                                              java.lang.String name,
                                                              java.lang.Class<?>... parameterTypes)

Returns any method exactly matching the given signature, including privates and on parent classes.

findMethodsCompatible

public static java.lang.Iterable<java.lang.reflect.Method> findMethodsCompatible(java.lang.Class<?> clazz,
                                                                                 java.lang.String name,
                                                                                 java.lang.Class<?>... parameterTypes)

Returns all methods compatible with the given argument types, including privates and on parent classes and where the method takes a supertype.

findMethod

@Deprecated
public static java.lang.reflect.Method findMethod(java.lang.Class<?> clazz,
                                                              java.lang.String name,
                                                              java.lang.Class<?>... parameterTypes)
                                                       throws java.lang.NoSuchMethodException

Deprecated. since 0.10.0 use findMethodMaybe(Class, String, Class...) or findMethodsCompatible(Class, String, Class...)

Throws:

java.lang.NoSuchMethodException

findField

public static java.lang.reflect.Field findField(java.lang.Class<?> clazz,
                                                java.lang.String name)
                                         throws java.lang.NoSuchFieldException

Finds the field with the given name declared on the given class or any superclass, using Class.getDeclaredField(String).

If the field name contains a '.' the field is interpreted as having DeclaringClassCanonicalName.FieldName format, allowing a way to set a field unambiguously if some are masked.

Throws:

java.lang.NoSuchFieldException - if not found

findFieldMaybe

public static Maybe<java.lang.reflect.Field> findFieldMaybe(java.lang.Class<?> clazz,
                                                            java.lang.String originalName)

getFieldValueMaybe

public static Maybe<java.lang.Object> getFieldValueMaybe(java.lang.Object instance,
                                                         java.lang.String fieldName)

getFieldValueMaybe

public static Maybe<java.lang.Object> getFieldValueMaybe(java.lang.Object instance,
                                                         java.lang.reflect.Field field)

findPublicFieldsOrderedBySuper

public static java.util.List<java.lang.reflect.Field> findPublicFieldsOrderedBySuper(java.lang.Class<?> clazz)

Lists all public fields declared on the class or any ancestor, with those HIGHEST in the hierarchy first

findFields

public static java.util.List<java.lang.reflect.Field> findFields(java.lang.Class<?> clazz,
                                                                 <any> filter,
                                                                 java.util.Comparator<java.lang.reflect.Field> fieldOrdering)

Lists all fields declared on the class, with those lowest in the hierarchy first, filtered and ordered as requested.

See ReflectionPredicates and FieldOrderings for conveniences.

Default is no filter and FieldOrderings.SUB_BEST_FIELD_LAST_THEN_ALPHABETICAL

findPublicMethodsOrderedBySuper

public static java.util.List<java.lang.reflect.Method> findPublicMethodsOrderedBySuper(java.lang.Class<?> clazz)

inferSubbestField

public static java.lang.reflect.Field inferSubbestField(java.lang.reflect.Field f1,
                                                        java.lang.reflect.Field f2)

If the classes of the fields satisfy inferSubbest(Class, Class) return the field in the lower (sub-best) class, otherwise null.

inferSubbestMethod

public static java.lang.reflect.Method inferSubbestMethod(java.lang.reflect.Method m1,
                                                          java.lang.reflect.Method m2)

If the classes of the methods satisfy inferSubbest(Class, Class) return the field in the lower (sub-best) class, otherwise null.

inferSubbest

public static java.lang.Class<?> inferSubbest(java.lang.Class<?> c1,
                                              java.lang.Class<?> c2)

If one class is a subclass of the other, return that (the lower in the type hierarchy); otherwise return null (if they are the same or neither is a subclass of the other).

cast

public static <T> T cast(java.lang.Object candidate,
                         java.lang.Class<? extends T> type)

convenience for casting the given candidate to the given type (without any coercion, and allowing candidate to be null)

invokeMethodWithArgs

@Deprecated
public static <any> invokeMethodWithArgs(java.lang.Object clazzOrInstance,
                                                     java.lang.String method,
                                                     java.util.List<?> args)
                                              throws java.lang.IllegalArgumentException,
                                                     java.lang.IllegalAccessException,
                                                     java.lang.reflect.InvocationTargetException

Deprecated. since 0.10.0 use invokeMethodFromArgs(Object, String, List); this allows null return values

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

invokeMethodWithArgs

@Deprecated
public static <any> invokeMethodWithArgs(java.lang.Object clazzOrInstance,
                                                     java.lang.String method,
                                                     java.util.List<?> args,
                                                     boolean setAccessible)
                                              throws java.lang.IllegalArgumentException,
                                                     java.lang.IllegalAccessException,
                                                     java.lang.reflect.InvocationTargetException

Deprecated. since 0.10.0 use invokeMethodFromArgs(Object, String, List)

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

invokeMethodFromArgs

public static Maybe<java.lang.Object> invokeMethodFromArgs(java.lang.Object clazzOrInstance,
                                                           java.lang.String method,
                                                           java.util.List<?> args)
                                                    throws java.lang.IllegalArgumentException,
                                                           java.lang.IllegalAccessException,
                                                           java.lang.reflect.InvocationTargetException

invokes the given method on the given clazz or instance, doing reasonably good matching on args etc

Throws:

java.lang.reflect.InvocationTargetException

java.lang.IllegalAccessException

java.lang.IllegalArgumentException

invokeMethodFromArgs

public static Maybe<java.lang.Object> invokeMethodFromArgs(java.lang.Object clazzOrInstance,
                                                           java.lang.String method,
                                                           java.util.List<?> args,
                                                           boolean setAccessible)
                                                    throws java.lang.IllegalArgumentException,
                                                           java.lang.IllegalAccessException,
                                                           java.lang.reflect.InvocationTargetException

as invokeMethodFromArgs(Object, String, List) but giving control over whether to set it accessible

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

invokeMethodFromArgs

public static Maybe<java.lang.Object> invokeMethodFromArgs(java.lang.Object clazzOrInstance,
                                                           java.lang.String method,
                                                           java.util.List<?> args,
                                                           boolean setAccessible,
                                                           <any> coercer)
                                                    throws java.lang.IllegalArgumentException,
                                                           java.lang.IllegalAccessException,
                                                           java.lang.reflect.InvocationTargetException

as invokeMethodFromArgs(Object, String, List) but giving control over whether to set it accessible

Throws:

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

getMethodFromArgs

public static Maybe<java.lang.reflect.Method> getMethodFromArgs(java.lang.Object clazzOrInstance,
                                                                java.lang.String method,
                                                                java.util.List<?> args)

searches for the given method on the given clazz or instance, doing reasonably good matching on args etc

getMethodFromArgs

public static Maybe<java.lang.reflect.Method> getMethodFromArgs(java.lang.Object clazzOrInstance,
                                                                java.lang.String method,
                                                                java.util.List<?> args,
                                                                <any> coercer)

searches for the given method on the given clazz or instance, doing reasonably good matching on args etc

invokeMethodFromArgs

public static java.lang.Object invokeMethodFromArgs(java.lang.Object clazzOrInstance,
                                                    java.lang.reflect.Method m,
                                                    java.util.List<?> args)
                                             throws java.lang.IllegalAccessException,
                                                    java.lang.reflect.InvocationTargetException

invokes the given method on the given clazz or instance, assuming that the method matches passed arguments

Throws:

java.lang.reflect.InvocationTargetException

java.lang.IllegalAccessException

java.lang.IllegalArgumentException

invokeMethodFromArgs

public static java.lang.Object invokeMethodFromArgs(java.lang.Object clazzOrInstance,
                                                    java.lang.reflect.Method m,
                                                    java.util.List<?> args,
                                                    boolean setAccessible)
                                             throws java.lang.IllegalAccessException,
                                                    java.lang.reflect.InvocationTargetException

as invokeMethodFromArgs(Object, Method, List) but giving control over whether to set it accessible

Throws:

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

invokeMethodFromArgs

public static java.lang.Object invokeMethodFromArgs(java.lang.Object clazzOrInstance,
                                                    java.lang.reflect.Method m,
                                                    java.util.List<?> args,
                                                    boolean setAccessible,
                                                    <any> coercer)
                                             throws java.lang.IllegalAccessException,
                                                    java.lang.reflect.InvocationTargetException

as invokeMethodFromArgs(Object, Method, List) but giving control over whether to set it accessible

Throws:

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

typesMatch

public static boolean typesMatch(java.lang.Object[] argsArray,
                                 java.lang.Class<?>[] parameterTypes)

true iff all args match the corresponding types

typesMatch

public static boolean typesMatch(java.lang.Object[] argsArray,
                                 java.lang.Class<?>[] parameterTypes,
                                 <any> coercer)

true iff all args match the corresponding types

typesMatchUpTo

public static boolean typesMatchUpTo(java.lang.Object[] argsArray,
                                     java.lang.Class<?>[] parameterTypes,
                                     int lengthRequired)

true iff the initial N args match the corresponding types

typesMatchUpTo

public static boolean typesMatchUpTo(java.lang.Object[] argsArray,
                                     java.lang.Class<?>[] parameterTypes,
                                     int lengthRequired,
                                     <any> coercer)

true iff the initial N args match the corresponding types

typeMatches

public static boolean typeMatches(java.lang.Object arg,
                                  java.lang.Class<?> parameterType,
                                  <any> coercer)

true iff the initial N args match the corresponding types

getAllInterfaces

public static java.util.List<java.lang.Class<?>> getAllInterfaces(@Nullable
                                                                  java.lang.Class<?> type)

Gets all the interfaces implemented by the given type, including its parent classes.

Parameters:

type - the class to look up

Returns:

an immutable list of the interface classes

hasNoArgConstructor

public static boolean hasNoArgConstructor(java.lang.Class<?> clazz)

hasNoNonObjectFields

public static boolean hasNoNonObjectFields(java.lang.Class<? extends java.lang.Object> clazz)

tryFindMappedName

@Deprecated
public static <any> tryFindMappedName(java.util.Map<java.lang.String,java.lang.String> renames,
                                                  java.lang.String name)

Deprecated. since 0.10.0 use findMappedNameMaybe(Map, String)

findMappedNameMaybe

public static Maybe<java.lang.String> findMappedNameMaybe(java.util.Map<java.lang.String,java.lang.String> renames,
                                                          java.lang.String name)

Takes a map of old-class-names to renames classes, and returns the mapped name if matched, or absent

findMappedNameAndLog

public static java.lang.String findMappedNameAndLog(java.util.Map<java.lang.String,java.lang.String> renames,
                                                    java.lang.String name)

hasSpecialSerializationMethods

public static boolean hasSpecialSerializationMethods(java.lang.Class<? extends java.lang.Object> type)

arrayToList

public static java.util.List<?> arrayToList(java.lang.Object input)

findAccessibleMethod

public static Maybe<java.lang.reflect.Method> findAccessibleMethod(java.lang.reflect.Method method)

Attempts to find an equivalent accessible method to be invoked (or if the given method is already accessible, then return it). Otherwise return absent. "Accessible" means that it is a public method declared on a public type. For example, if method is declared on a private sub-class, but that overides a method declared on a public super-class, then this method will return the Method instance for the public super-class (assuming the method is not static). If no better method could be found, it does a log.warn (once per method signature, per jvm-invocation), and then returns absent.

trySetAccessible

public static boolean trySetAccessible(java.lang.reflect.Method method)

Calls AccessibleObject.setAccessible(boolean) "safely", wrapping in a try-catch block so that the exception is never propagated.

It will log.warn once per method signature for which we fail to set it accessible. It will also log.warn if it succeeds (once per method signature) as this is discouraged!

Returns:

True if setAccessible succeeded; false otherwise

getGenericParameterTypeTokens

public static <any>[] getGenericParameterTypeTokens(<any> t)