Reflections (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.util.javalang.Reflections

```
public class Reflections
extends java.lang.Object
```
Reflection utilities ("borrowed" from cloudsoft monterey).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Reflections.ReflectionAccessException

static class Reflections.ReflectionNotFoundException

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)

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

Method Summary

Methods
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 <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 java.lang.reflect.Field`	`findField(java.lang.Class<?> clazz, java.lang.String name)`
`static java.lang.String`	`findMappedNameAndLog(java.util.Map<java.lang.String,java.lang.String> renames, java.lang.String name)`
`static java.lang.reflect.Method`	`findMethod(java.lang.Class<?> clazz, java.lang.String name, java.lang.Class<?>... parameterTypes)`
`static java.util.List<java.lang.reflect.Field>`	`findPublicFieldsOrderedBySuper(java.lang.Class<?> clazz)`
`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 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)
`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 java.lang.Class<?>`	`inferSubbest(java.lang.Class<?> c1, java.lang.Class<?> c2)` Gets the class that is in the sub-class; or null if neither is a sub-class of the other.
`static java.lang.reflect.Field`	`inferSubbestField(java.lang.reflect.Field f1, java.lang.reflect.Field f2)` Gets the field that is in the sub-class; or null if one field does not come from a sub-class of the other field's class
`static java.lang.reflect.Method`	`inferSubbestMethod(java.lang.reflect.Method m1, java.lang.reflect.Method m2)` Gets the method that is in the sub-class; or null if one method does not come from a sub-class of the other method's class
`static <T> com.google.common.base.Optional<T>`	`invokeConstructorWithArgs(java.lang.Class<T> clazz, java.lang.Object... argsArray)` Invokes a suitable constructor, supporting varargs and primitives
`static <T> com.google.common.base.Optional<T>`	`invokeConstructorWithArgs(java.lang.Class<T> clazz, java.lang.Object[] argsArray, boolean setAccessible)` Invokes a suitable constructor, supporting varargs and primitives
`static <T> com.google.common.base.Optional<T>`	`invokeConstructorWithArgs(java.lang.ClassLoader classLoader, java.lang.Class<T> clazz, java.lang.Object[] argsArray, boolean setAccessible)` Invokes a suitable constructor, supporting varargs and primitives
`static <T> com.google.common.base.Optional<T>`	`invokeConstructorWithArgs(java.lang.ClassLoader classLoader, java.lang.String className, java.lang.Object... argsArray)` Invokes a suitable constructor, supporting varargs and primitives
`static <T> com.google.common.base.Optional<T>`	`invokeConstructorWithArgs(Reflections reflections, java.lang.Class<T> clazz, java.lang.Object[] argsArray, boolean setAccessible)` Invokes a suitable constructor, supporting varargs and primitives, additionally supporting setAccessible
`java.lang.Object`	`invokeMethod(java.lang.reflect.Method method, java.lang.Object obj, java.lang.Object... argValues)`
`static com.google.common.base.Optional<java.lang.Object>`	`invokeMethodWithArgs(java.lang.Object clazzOrInstance, java.lang.String method, java.util.List<java.lang.Object> args)` invokes the given method on the given clazz or instance, doing reasonably good matching on args etc
`static com.google.common.base.Optional<java.lang.Object>`	`invokeMethodWithArgs(java.lang.Object clazzOrInstance, java.lang.String method, java.util.List<java.lang.Object> args, boolean setAccessible)`
`java.lang.Object`	`invokeStaticMethod(java.lang.reflect.Method method, java.lang.Object... argValues)`
`java.lang.Class<?>`	`loadClass(java.lang.String classname)` instantiates the given class from its binary name
`<T> java.lang.Class<? extends T>`	`loadClass(java.lang.String classname, java.lang.Class<T> superType)`
`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)` does not look through ancestors of outer class
`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)`
`java.lang.Object`	`loadInstance(java.lang.String classname, java.lang.Class<?>[] argTypes, java.lang.Object[] argValues)`
`java.lang.Object`	`loadInstance(java.lang.String classname, java.lang.Object... argValues)`
`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 com.google.common.base.Optional<java.lang.String>`	`tryFindMappedName(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 boolean`	`typesMatch(java.lang.Object[] argsArray, java.lang.Class<?>[] parameterTypes)` 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
`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

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

Throws:: Reflections.ReflectionNotFoundException; Reflections.ReflectionAccessException

loadInstance

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

Throws:: Reflections.ReflectionNotFoundException; Reflections.ReflectionAccessException

loadClass

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

instantiates the given class from its binary name

Throws:: Reflections.ReflectionNotFoundException

loadClass

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

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

does not look through ancestors of outer class

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

public static <T> com.google.common.base.Optional<T> invokeConstructorWithArgs(java.lang.ClassLoader classLoader,
                                                               java.lang.String className,
                                                               java.lang.Object... argsArray)

Invokes a suitable constructor, supporting varargs and primitives

invokeConstructorWithArgs

public static <T> com.google.common.base.Optional<T> invokeConstructorWithArgs(java.lang.ClassLoader classLoader,
                                                               java.lang.Class<T> clazz,
                                                               java.lang.Object[] argsArray,
                                                               boolean setAccessible)

Invokes a suitable constructor, supporting varargs and primitives

invokeConstructorWithArgs

public static <T> com.google.common.base.Optional<T> invokeConstructorWithArgs(java.lang.Class<T> clazz,
                                                               java.lang.Object... argsArray)

Invokes a suitable constructor, supporting varargs and primitives

invokeConstructorWithArgs

public static <T> com.google.common.base.Optional<T> invokeConstructorWithArgs(java.lang.Class<T> clazz,
                                                               java.lang.Object[] argsArray,
                                                               boolean setAccessible)

Invokes a suitable constructor, supporting varargs and primitives

invokeConstructorWithArgs

public static <T> com.google.common.base.Optional<T> invokeConstructorWithArgs(Reflections reflections,
                                                               java.lang.Class<T> clazz,
                                                               java.lang.Object[] argsArray,
                                                               boolean setAccessible)

Invokes a suitable constructor, supporting varargs and primitives, additionally supporting setAccessible

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)

findMethod

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

Throws:: java.lang.NoSuchMethodException

findField

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

Throws:: java.lang.NoSuchFieldException

findPublicFieldsOrderedBySuper

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

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)

Gets the field that is in the sub-class; or null if one field does not come from a sub-class of the other field's class

inferSubbestMethod

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

Gets the method that is in the sub-class; or null if one method does not come from a sub-class of the other method's class

inferSubbest

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

Gets the class that is in the sub-class; or null if neither is a sub-class 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

public static com.google.common.base.Optional<java.lang.Object> invokeMethodWithArgs(java.lang.Object clazzOrInstance,
                                                                     java.lang.String method,
                                                                     java.util.List<java.lang.Object> 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

invokeMethodWithArgs

public static com.google.common.base.Optional<java.lang.Object> invokeMethodWithArgs(java.lang.Object clazzOrInstance,
                                                                     java.lang.String method,
                                                                     java.util.List<java.lang.Object> args,
                                                                     boolean setAccessible)
                                                                              throws java.lang.IllegalArgumentException,
                                                                                     java.lang.IllegalAccessException,
                                                                                     java.lang.reflect.InvocationTargetException

Throws:: java.lang.IllegalArgumentException; 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

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

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

public static com.google.common.base.Optional<java.lang.String> tryFindMappedName(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)

Class Reflections

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Reflections

Method Detail

applyClassRenames

loadInstance

loadInstance

loadInstance

loadClass

loadClass

loadInnerClassPossiblyInheritted

loadInnerClassNotInheritted

loadInnerClassNotInheritted

loadConstructor

invokeConstructorWithArgs

invokeConstructorWithArgs

invokeConstructorWithArgs

invokeConstructorWithArgs

invokeConstructorWithArgs

loadSingleConstructor

loadInstance

loadMethod

loadMethod

invokeMethod

invokeStaticMethod

loadStaticField

loadStaticFields

copyFields

loadClassFromCanonicalName

getResource

updateFromNewClassLoader

getClassLoader

findSuperType

getInterfacesIncludingClassAncestors

findMethod

findField

findPublicFieldsOrderedBySuper

findPublicMethodsOrderedBySuper

inferSubbestField

inferSubbestMethod

inferSubbest

cast

invokeMethodWithArgs

invokeMethodWithArgs

typesMatch

typesMatchUpTo

getAllInterfaces

hasNoArgConstructor

hasNoNonObjectFields

tryFindMappedName

findMappedNameAndLog