com.screenscraper.profiling

Class ReflectionUtils

java.lang.Object

com.screenscraper.profiling.ReflectionUtils

public final class ReflectionUtils
extends java.lang.Object

Utilities used for Reflection. Author: Mike Date: 1/18/12 Time: 2:36 PM

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReflectionUtils.Wildcard Simple placeholder class that can match on anything for parameter types.

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.Object>	convertObjectToDeepMap(java.lang.Object object) Converts the given object to a deep map.
static java.util.Map<java.lang.String,java.lang.Object>	convertObjectToMap(java.lang.Object object) Converts the given object to a shallow map.
static <T> T	createObject(java.lang.Class<?> clazz, java.lang.Object... params) Creates an instance object of the given class and returns it
static <T> T	executeMethod(java.lang.Object object, java.lang.String methodName, java.lang.Object... params) Executes a method with the given name on the given object.
static <T> T	executeStaticMethod(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Object... params) Executes a method with the given name on the given object.
static void	filterClassesByExcludedModifier(java.util.Collection<java.lang.Class<?>> classes, boolean requireAll, int... modifiers) Filters out all reflected values that don't match the given modifiers
static void	filterClassesByRequiredModifier(java.util.Collection<java.lang.Class<?>> classes, boolean requireAll, int... modifiers) Filters out all reflected values that don't match the given modifiers
static <U extends java.lang.reflect.Member> void	filterMembersByExcludedModifier(java.util.Collection<U> members, boolean requireAll, int... modifiers) Filters out all reflected values that don't match the given modifiers
static <U extends java.lang.reflect.Member> void	filterMembersByRequiredModifier(java.util.Collection<U> members, boolean requireAll, int... modifiers) Filters out all reflected values that don't match the given modifiers
static java.util.Set<java.lang.reflect.Constructor>	getAllConstructorsInClass(java.lang.Class<?> clazz, int... excludedModifiers) Returns all constructors in the class, using modifiers to exclude specific types
static java.util.Set<java.lang.reflect.Field>	getAllFieldsInClass(java.lang.Class<?> clazz, int... excludedModifiers) Returns all fields in the class, using modifiers to exclude specific types
static java.util.Set<java.lang.Class<?>>	getAllInnerClassesInClass(java.lang.Class<?> clazz, boolean includeMultipleLevels, int... excludedModifiers) Returns all inner classes in the given class.
static java.util.Set<java.lang.Class<?>>	getAllInnerClassesInClassIgnoreParentClasses(java.lang.Class<?> clazz, boolean includeMultipleLevels, int... excludedModifiers) Returns all inner classes in the given class.
static <T> java.util.List<java.lang.reflect.Constructor>	getAllMatchingConstructorsInClass(java.lang.Class<?> clazz, java.lang.Class<?>... paramTypes) Gets the method with the given name in the given class.
static <T> java.util.List<java.lang.reflect.Constructor>	getAllMatchingConstructorsInClass(java.lang.Class<?> clazz, java.util.List<java.lang.Class<T>> annotations, java.lang.Class<?>... paramTypes) Gets the method with the given name in the given class.
static java.util.List<java.lang.reflect.Method>	getAllMatchingMethodsInClass(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Class<?>... paramTypes) Gets the method with the given name in the given class.
static java.util.Set<java.lang.reflect.Method>	getAllMethodsInClass(java.lang.Class<?> clazz, int... excludedModifiers) Returns all methods in the class, using modifiers to exclude specific types
static java.util.Collection<java.lang.reflect.Method>	getAllMethodsWithAnnotation(java.lang.Class<?> clazz, java.lang.Class<? extends java.lang.annotation.Annotation> annotation) Returns a collection of all methods that had a specific set of annotations
static java.util.Collection<java.lang.reflect.Method>	getAllMethodsWithAnnotation(java.lang.Class<?> clazz, java.util.Set<java.lang.Class<? extends java.lang.annotation.Annotation>> annotations) Returns a collection of all methods that had a specific set of annotations
static java.util.Set<java.lang.Class<?>>	getAllParentClasses(java.lang.Class<?> clazz) Returns a set of all parent classes and interfaces in for the given class
static java.lang.Class<?>	getBoxedType(java.lang.Class<?> primitive) Converts a primitive class to it corresponding boxed type
static java.lang.Class<?>	getClassFromSimpleString(java.lang.String className) Gets a class from a simple String name (converting array notation)
static java.lang.Class<?>	getClassFromSimpleStringWithImports(java.util.Collection<java.lang.String> imports, java.lang.String className) Attempts to resolve a class given a set of imported packages and classes.
static java.lang.reflect.Constructor	getConstructorInClass(java.lang.Class<?> clazz, java.lang.Class<?>... paramTypes) Gets the method with the given name in the given class.
static <T> T	getDataMember(java.lang.Object object, java.lang.String fieldName) Gets the data member off a given object.
static java.lang.reflect.Field	getFieldInClass(java.lang.Class<?> clazz, java.lang.String fieldName) Gets the field with the given name in the given class.
static java.util.Set<java.lang.Class<?>>	getImmediateParentClasses(java.lang.Class<?> clazz) Returns a set of all immediate parent classes and interfaces in for the given class
static java.lang.reflect.Method	getMethodInClass(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Class<?>... paramTypes) Gets the method with the given name in the given class.
static java.lang.Class<?>	getMethodReturnTypeInClass(java.lang.Class<?> clazz, java.lang.String methodName, java.lang.Class<?>... paramTypes) Gets the method with the given name in the given class.
static java.util.Set<java.lang.reflect.Method>	getMethodsInClass(java.lang.Class<?> clazz, java.lang.String methodName) Returns the methods found in the given class.
static java.lang.String	getPackageName(java.lang.Class<?> clazz) Gets the name of the package that the given class is in.
static java.lang.Class<?>	getRootClassOfArray(java.lang.Class<?> clazz) Gets the root class of an object.
static java.lang.String	getSimpleClassName(java.lang.Class<?> clazz) Returns the simple name of a class, for example, returns java.lang.String[][] rather than [[Ljava.lang.String;
static java.lang.String	getSimpleClassName(java.lang.Class<?> clazz, boolean showPackage) Returns the simple name of a class, for example, returns java.lang.String[][] rather than [[Ljava.lang.String;
static <T> T	getStaticDataMember(java.lang.Class<?> clazz, java.lang.String fieldName) Gets the static data member off a given object.
static int	getStepsBetweenClasses(java.lang.Class<?> parent, java.lang.Class<?> child) Gets the number of steps it takes to go from the child to the parent.
static java.lang.Class<?>	getWildcardClass() Returns a simple placeholder class that can match on anything for parameter types, and is returned as the return type when multiple methods match, having multiple return types, and the best match used the wildcard class.
static boolean	isClassChildOfClass(java.lang.Class<?> parent, java.lang.Class<?> child) Checks to see if one class is a child of another.
static boolean	isPrimitiveArrayType(java.lang.Class<?> clazz) Checks to see if the array is of primitive type
static void	setDataMember(java.lang.Object object, java.lang.String fieldName, java.lang.Object value) Gets the data member off a given object.
static void	setStaticDataMember(java.lang.Class<?> clazz, java.lang.String fieldName, java.lang.Object value) Gets the static data member off a given object.
static boolean	shouldFilterByExcludedModifiers(int objectModifiers, boolean requireAll, int... modifiers) Checks to see if the modifiers for a given object match at least one or possibly all the modifiers listed
static boolean	shouldFilterByRequiredModifiers(int objectModifiers, boolean requireAll, int... modifiers) Checks to see if the modifiers for a given object match at least one or possibly all the modifiers listed

Methods inherited from class java.lang.Object

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

Method Detail

getWildcardClass

@NotNull
public static java.lang.Class<?> getWildcardClass()

Returns a simple placeholder class that can match on anything for parameter types, and is returned as the return type when multiple methods match, having multiple return types, and the best match used the wildcard class.

Returns:

A simple placeholder class that can match on anything for parameter types, and is returned as the return type when multiple methods match, having multiple return types, and the best match used the wildcard class.

getSimpleClassName

public static java.lang.String getSimpleClassName(@NotNull
                                                  java.lang.Class<?> clazz)

Returns the simple name of a class, for example, returns java.lang.String[][] rather than [[Ljava.lang.String;

Parameters:

clazz - The class to convert to a String

Returns:

The common (in code) name of the class

getPackageName

@NotNull
public static java.lang.String getPackageName(@NotNull
                                                        java.lang.Class<?> clazz)

Gets the name of the package that the given class is in. Inner classes are still part of the same package as the parent

Parameters:

clazz - The class to get the package of

Returns:

The package that contains the given class

getSimpleClassName

public static java.lang.String getSimpleClassName(@NotNull
                                                  java.lang.Class<?> clazz,
                                                  boolean showPackage)

Returns the simple name of a class, for example, returns java.lang.String[][] rather than [[Ljava.lang.String;

Parameters:

clazz - The class to convert to a String

showPackage - True if the package should be included in the class name, false otherwise

Returns:

The common (in code) name of the class

getClassFromSimpleString

@Nullable
public static java.lang.Class<?> getClassFromSimpleString(@Nullable
                                                                     java.lang.String className)
                                                              throws java.lang.ClassNotFoundException

Gets a class from a simple String name (converting array notation)

Parameters:

className - The name of the class

Returns:

The Class object representing this type

Throws:

java.lang.ClassNotFoundException - If the class could not be found

getClassFromSimpleStringWithImports

@Nullable
public static java.lang.Class<?> getClassFromSimpleStringWithImports(@Nullable
                                                                                java.util.Collection<java.lang.String> imports,
                                                                                @Nullable
                                                                                java.lang.String className)
                                                                         throws java.lang.ClassNotFoundException

Attempts to resolve a class given a set of imported packages and classes.

Parameters:

imports - A Collection of the imported packages, such as java.util.Set or java.io.*

className - The text entered as the class name, such as Set or java.util.Set

Returns:

The Class object representing the given class name

Throws:

java.lang.ClassNotFoundException - If no matching class could be found

isPrimitiveArrayType

public static boolean isPrimitiveArrayType(@Nullable
                                           java.lang.Class<?> clazz)

Checks to see if the array is of primitive type

Parameters:

clazz - The class to check

Returns:

True if this array is a primitive type, false otherwise

getAllFieldsInClass

@NotNull
public static java.util.Set<java.lang.reflect.Field> getAllFieldsInClass(@Nullable
                                                                                   java.lang.Class<?> clazz,
                                                                                   int... excludedModifiers)

Returns all fields in the class, using modifiers to exclude specific types

Parameters:

clazz - The class to get fields for

excludedModifiers - The modifiers of things to exclude

Returns:

The fields in the class and any parent classes, excluding those specified by the modifiers given

getFieldInClass

@NotNull
public static java.lang.reflect.Field getFieldInClass(@NotNull
                                                                java.lang.Class<?> clazz,
                                                                @Nullable
                                                                java.lang.String fieldName)
                                                         throws java.lang.NoSuchFieldException

Gets the field with the given name in the given class. This may be a static field or an instance variable.

Parameters:

clazz - The class containing the named field

fieldName - The name of the field to get

Returns:

The field requested

Throws:

java.lang.NoSuchFieldException - If the field could not be found

getRootClassOfArray

@Nullable
public static java.lang.Class<?> getRootClassOfArray(@Nullable
                                                                java.lang.Class<?> clazz)

Gets the root class of an object. Strips off the array types

Parameters:

clazz - The class in question

Returns:

The root class type of the class given

getAllMethodsInClass

@NotNull
public static java.util.Set<java.lang.reflect.Method> getAllMethodsInClass(@Nullable
                                                                                     java.lang.Class<?> clazz,
                                                                                     int... excludedModifiers)

Returns all methods in the class, using modifiers to exclude specific types

Parameters:

clazz - The class to get methods for

excludedModifiers - The modifiers of things to exclude

Returns:

The methods in the class and any parent classes, excluding those specified by the modifiers given

getAllInnerClassesInClass

@NotNull
public static java.util.Set<java.lang.Class<?>> getAllInnerClassesInClass(@Nullable
                                                                                    java.lang.Class<?> clazz,
                                                                                    boolean includeMultipleLevels,
                                                                                    int... excludedModifiers)

Returns all inner classes in the given class. This method will also get the inner classes of parent classes

Parameters:

clazz - The class to get inner classes from

includeMultipleLevels - True if the inner classes of inner classes should be included, false otherwise

excludedModifiers - The modifiers of things to exclude

Returns:

The inner classes, and any of their inner classes

getAllInnerClassesInClassIgnoreParentClasses

@NotNull
public static java.util.Set<java.lang.Class<?>> getAllInnerClassesInClassIgnoreParentClasses(@Nullable
                                                                                                       java.lang.Class<?> clazz,
                                                                                                       boolean includeMultipleLevels,
                                                                                                       int... excludedModifiers)

Returns all inner classes in the given class. This method will not check for inner classes in parent classes

Parameters:

clazz - The class to get inner classes from

includeMultipleLevels - True if the inner classes of inner classes should be included, false otherwise

excludedModifiers - The modifiers of things to exclude

Returns:

The inner classes, and any of their inner classes

getAllConstructorsInClass

@NotNull
public static java.util.Set<java.lang.reflect.Constructor> getAllConstructorsInClass(@Nullable
                                                                                               java.lang.Class<?> clazz,
                                                                                               int... excludedModifiers)

Returns all constructors in the class, using modifiers to exclude specific types

Parameters:

clazz - The class to get methods for

excludedModifiers - The modifiers of things to exclude

Returns:

The methods in the class and any parent classes, excluding those specified by the modifiers given

getAllMatchingConstructorsInClass

@NotNull
public static <T> java.util.List<java.lang.reflect.Constructor> getAllMatchingConstructorsInClass(java.lang.Class<?> clazz,
                                                                                                            java.lang.Class<?>... paramTypes)

Gets the method with the given name in the given class. Takes a list of parameter types the method accepts.

Parameters:

clazz - The class with the given method

paramTypes - The types of parameters this method accepts

Returns:

A list of all methods that are potential matches for the given signature. The list is sorted by best match. An empty list indicates no matches

getAllMatchingConstructorsInClass

@NotNull
public static <T> java.util.List<java.lang.reflect.Constructor> getAllMatchingConstructorsInClass(java.lang.Class<?> clazz,
                                                                                                            java.util.List<java.lang.Class<T>> annotations,
                                                                                                            @NotNull
                                                                                                            java.lang.Class<?>... paramTypes)

Gets the method with the given name in the given class. Takes a list of parameter types the method accepts.

Parameters:

clazz - The class with the given method

paramTypes - The types of parameters this method accepts

Returns:

A list of all methods that are potential matches for the given signature. The list is sorted by best match. An empty list indicates no matches

getConstructorInClass

@Nullable
public static java.lang.reflect.Constructor getConstructorInClass(@NotNull
                                                                             java.lang.Class<?> clazz,
                                                                             @NotNull
                                                                             java.lang.Class<?>... paramTypes)
                                                                      throws java.lang.NoSuchMethodException

Gets the method with the given name in the given class. Takes a list of parameter types the method accepts.

Parameters:

clazz - The class with the given method

paramTypes - The types of parameters this method accepts

Returns:

The method that was found with the closest match (ie a method(String) and method(Object) would return the String version if a String was passed as the type

Throws:

java.lang.NoSuchMethodException - If no method could be found with the given signature

getMethodsInClass

@NotNull
public static java.util.Set<java.lang.reflect.Method> getMethodsInClass(@NotNull
                                                                                  java.lang.Class<?> clazz,
                                                                                  @Nullable
                                                                                  java.lang.String methodName)
                                                                           throws java.lang.NoSuchMethodException

Returns the methods found in the given class. If no method with that name is found, an exception is thrown.

Parameters:

clazz - The class containing the given method

methodName - The name of the method

Returns:

The Method with the given name available in the given class

Throws:

java.lang.NoSuchMethodException - When the method was not found

getAllMethodsWithAnnotation

@NotNull
public static java.util.Collection<java.lang.reflect.Method> getAllMethodsWithAnnotation(java.lang.Class<?> clazz,
                                                                                                   java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

Returns a collection of all methods that had a specific set of annotations

Parameters:

clazz - The class to get methods from

annotation - An annotation that must be present

Returns:

A collection of methods that have a given annotation and are in the given class

getAllMethodsWithAnnotation

@NotNull
public static java.util.Collection<java.lang.reflect.Method> getAllMethodsWithAnnotation(java.lang.Class<?> clazz,
                                                                                                   @NotNull
                                                                                                   java.util.Set<java.lang.Class<? extends java.lang.annotation.Annotation>> annotations)

Returns a collection of all methods that had a specific set of annotations

Parameters:

clazz - The class to get methods from

annotations - A set of the annotations that must be present

Returns:

A collection of methods that have a given annotation and are in the given class

getAllMatchingMethodsInClass

@NotNull
public static java.util.List<java.lang.reflect.Method> getAllMatchingMethodsInClass(@NotNull
                                                                                              java.lang.Class<?> clazz,
                                                                                              java.lang.String methodName,
                                                                                              @NotNull
                                                                                              java.lang.Class<?>... paramTypes)

Gets the method with the given name in the given class. Takes a list of parameter types the method accepts.

Parameters:

clazz - The class with the given method

methodName - The name of the method

paramTypes - The types of parameters this method accepts

Returns:

A list of all methods that are potential matches for the given signature. The list is sorted by best match. An empty list indicates no matches

getMethodInClass

@NotNull
public static java.lang.reflect.Method getMethodInClass(@NotNull
                                                                  java.lang.Class<?> clazz,
                                                                  java.lang.String methodName,
                                                                  java.lang.Class<?>... paramTypes)
                                                           throws java.lang.NoSuchMethodException

Gets the method with the given name in the given class. Takes a list of parameter types the method accepts.

Parameters:

clazz - The class with the given method

methodName - The name of the method

paramTypes - The types of parameters this method accepts

Returns:

The method that was found with the closest match (ie a method(String) and method(Object) would return the String version if a String was passed as the type. If one of the parameters given was the wildcard class, there is no guarantee which method will be returned if multiple methods were a valid match

Throws:

java.lang.NoSuchMethodException - If no method could be found with the given signature

getMethodReturnTypeInClass

@NotNull
public static java.lang.Class<?> getMethodReturnTypeInClass(@NotNull
                                                                      java.lang.Class<?> clazz,
                                                                      java.lang.String methodName,
                                                                      java.lang.Class<?>... paramTypes)
                                                               throws java.lang.NoSuchMethodException

Gets the method with the given name in the given class. Takes a list of parameter types the method accepts.

Parameters:

clazz - The class with the given method

methodName - The name of the method

paramTypes - The types of parameters this method accepts

Returns:

The return type of the method if a valid method was found with a correct match, or the ReflectionUtils.Wildcard class if multiple methods matched, and the best match used the wildcard class

Throws:

java.lang.NoSuchMethodException - If no method could be found with the given signature

getStepsBetweenClasses

public static int getStepsBetweenClasses(@Nullable
                                         java.lang.Class<?> parent,
                                         @Nullable
                                         java.lang.Class<?> child)

Gets the number of steps it takes to go from the child to the parent. Arrays cannot go to another type, except Object. If the child is null and the parent isn't a primitive type, the path is 0 in length

Parameters:

parent - The parent class

child - The child class

Returns:

The number of steps to get from the child to the parent, or -1 if no path can be found.

isClassChildOfClass

public static boolean isClassChildOfClass(java.lang.Class<?> parent,
                                          java.lang.Class<?> child)

Checks to see if one class is a child of another. Basically this is the same as "child instanceof parent", but when you don't have an object of the child class.

Parameters:

parent - The parent class

child - The class to determine if it is a subclass or child of the parent

Returns:

True if the child class in some way extends or implements the parent

getAllParentClasses

@NotNull
public static java.util.Set<java.lang.Class<?>> getAllParentClasses(@Nullable
                                                                              java.lang.Class<?> clazz)

Returns a set of all parent classes and interfaces in for the given class

Parameters:

clazz - The class to get parent classes of

Returns:

A set of all parent/super classes and interfaces for the given class

getImmediateParentClasses

@NotNull
public static java.util.Set<java.lang.Class<?>> getImmediateParentClasses(@Nullable
                                                                                    java.lang.Class<?> clazz)

Returns a set of all immediate parent classes and interfaces in for the given class

Parameters:

clazz - The class to get parent classes of

Returns:

A set of all immediate parent/super classes and interfaces for the given class

getDataMember

@NotNull
public static <T> T getDataMember(@Nullable
                                            java.lang.Object object,
                                            java.lang.String fieldName)
                                     throws java.lang.NoSuchFieldException,
                                            java.lang.IllegalAccessException

Gets the data member off a given object.

Parameters:

object - The object containing the data member

fieldName - The name of the field to get, as named from the code

Returns:

The object in the given field

Throws:

java.lang.NoSuchFieldException - If the field doesn't exist on the object

java.lang.IllegalAccessException - If the object doesn't allow access to the field

java.lang.ClassCastException - If the type of T doesn't match the object

getStaticDataMember

@NotNull
public static <T> T getStaticDataMember(@Nullable
                                                  java.lang.Class<?> clazz,
                                                  java.lang.String fieldName)
                                           throws java.lang.NoSuchFieldException,
                                                  java.lang.IllegalAccessException

Gets the static data member off a given object.

Parameters:

clazz - The class containing the static data member

fieldName - The name of the field to get, as named from the code

Returns:

The object in the given field

Throws:

java.lang.NoSuchFieldException - If the field doesn't exist on the object

java.lang.IllegalAccessException - If the object doesn't allow access to the field

java.lang.ClassCastException - If the type of T doesn't match the object

setDataMember

public static void setDataMember(@Nullable
                                 java.lang.Object object,
                                 java.lang.String fieldName,
                                 java.lang.Object value)
                          throws java.lang.NoSuchFieldException,
                                 java.lang.IllegalAccessException

Gets the data member off a given object.

Parameters:

object - The object containing the data member

fieldName - The name of the field to set, as named from the code

value - The value to set in the object

Throws:

java.lang.NoSuchFieldException - If the field doesn't exist on the object

java.lang.IllegalAccessException - If the object doesn't allow access to the field

java.lang.ClassCastException - If the type of the object given for the value isn't allowed in the field

setStaticDataMember

public static void setStaticDataMember(@Nullable
                                       java.lang.Class<?> clazz,
                                       java.lang.String fieldName,
                                       java.lang.Object value)
                                throws java.lang.NoSuchFieldException,
                                       java.lang.IllegalAccessException

Gets the static data member off a given object.

Parameters:

clazz - The class containing the static data member

fieldName - The name of the field to set, as named from the code

value - The value to set in the object

Throws:

java.lang.NoSuchFieldException - If the field doesn't exist on the object

java.lang.IllegalAccessException - If the object doesn't allow access to the field

java.lang.ClassCastException - If the type of the object given for the value isn't allowed in the field

executeMethod

public static <T> T executeMethod(@Nullable
                                  java.lang.Object object,
                                  java.lang.String methodName,
                                  @NotNull
                                  java.lang.Object... params)
                           throws java.lang.NoSuchMethodException,
                                  java.lang.reflect.InvocationTargetException,
                                  java.lang.IllegalAccessException

Executes a method with the given name on the given object. If the method to execute is static, the object can be null

Type Parameters:

T - The type to return

Parameters:

object - The object to execute the method on

methodName - The name of the method to execute

params - The parameters to give to the method

Returns:

The result of the method call

Throws:

java.lang.NoSuchMethodException - If the method doesn't exist (either by name or parameter list)

java.lang.reflect.InvocationTargetException - Error invoking the method

java.lang.IllegalAccessException - Unable to access the method

java.lang.ClassCastException - The return type required is incorrect

executeStaticMethod

public static <T> T executeStaticMethod(@Nullable
                                        java.lang.Class<?> clazz,
                                        java.lang.String methodName,
                                        @NotNull
                                        java.lang.Object... params)
                                 throws java.lang.NoSuchMethodException,
                                        java.lang.reflect.InvocationTargetException,
                                        java.lang.IllegalAccessException

Executes a method with the given name on the given object. If the method to execute is static, the object can be null

Type Parameters:

T - The type to return

Parameters:

clazz - The class to execute the method on

methodName - The name of the method to execute

params - The parameters to give to the method

Returns:

The result of the method call

Throws:

java.lang.NoSuchMethodException - If the method doesn't exist (either by name or parameter list)

java.lang.reflect.InvocationTargetException - Error invoking the method

java.lang.IllegalAccessException - Unable to access the method

java.lang.ClassCastException - The return type required is incorrect

createObject

public static <T> T createObject(@Nullable
                                 java.lang.Class<?> clazz,
                                 @NotNull
                                 java.lang.Object... params)
                          throws java.lang.NoSuchMethodException,
                                 java.lang.reflect.InvocationTargetException,
                                 java.lang.IllegalAccessException,
                                 java.lang.InstantiationException

Creates an instance object of the given class and returns it

Parameters:

clazz - The class type to create

params - The parameters to give to the method

Returns:

The result of the method call

Throws:

java.lang.NoSuchMethodException - If the constructor doesn't exist (either by parameter list)

java.lang.reflect.InvocationTargetException - Error invoking the constructor

java.lang.IllegalAccessException - Unable to access the constructor

java.lang.InstantiationException - An error occurred when trying to build the object

java.lang.ClassCastException - The return type required is incorrect

filterMembersByRequiredModifier

public static <U extends java.lang.reflect.Member> void filterMembersByRequiredModifier(@NotNull
                                                                                        java.util.Collection<U> members,
                                                                                        boolean requireAll,
                                                                                        int... modifiers)

Filters out all reflected values that don't match the given modifiers

Parameters:

members - The collection of members

requireAll - True to require a field to match all modifiers, false to require at least one to match

modifiers - The modifiers that are allowed

filterMembersByExcludedModifier

public static <U extends java.lang.reflect.Member> void filterMembersByExcludedModifier(@NotNull
                                                                                        java.util.Collection<U> members,
                                                                                        boolean requireAll,
                                                                                        int... modifiers)

Filters out all reflected values that don't match the given modifiers

Parameters:

members - The collection of members

requireAll - True to require a field to exclude all modifiers, false to require at least one to be excluded

modifiers - The modifiers that are allowed

filterClassesByRequiredModifier

public static void filterClassesByRequiredModifier(@NotNull
                                                   java.util.Collection<java.lang.Class<?>> classes,
                                                   boolean requireAll,
                                                   int... modifiers)

Filters out all reflected values that don't match the given modifiers

Parameters:

classes - The collection of classes

requireAll - True to require a class to match all modifiers, false to require at least one to match

modifiers - The modifiers that are allowed

filterClassesByExcludedModifier

public static void filterClassesByExcludedModifier(@NotNull
                                                   java.util.Collection<java.lang.Class<?>> classes,
                                                   boolean requireAll,
                                                   int... modifiers)

Filters out all reflected values that don't match the given modifiers

Parameters:

classes - The collection of classes

requireAll - True to require a class to exclude all modifiers, false to require at least one to be excluded

modifiers - The modifiers that are allowed

shouldFilterByRequiredModifiers

public static boolean shouldFilterByRequiredModifiers(int objectModifiers,
                                                      boolean requireAll,
                                                      @Nullable
                                                      int... modifiers)

Checks to see if the modifiers for a given object match at least one or possibly all the modifiers listed

Parameters:

objectModifiers - The modifier value for the object in question

requireAll - True to require all modifiers to match, false to require at least one, but not necessarily all, to match

modifiers - The modifiers that should match

Returns:

True if the conditions were met, false otherwise

shouldFilterByExcludedModifiers

public static boolean shouldFilterByExcludedModifiers(int objectModifiers,
                                                      boolean requireAll,
                                                      @Nullable
                                                      int... modifiers)

Checks to see if the modifiers for a given object match at least one or possibly all the modifiers listed

Parameters:

objectModifiers - The modifier value for the object in question

requireAll - True to require all modifiers to match, false to require at least one, but not necessarily all, to match

modifiers - The modifiers that should match

Returns:

True if the conditions were met, false otherwise

convertObjectToMap

@NotNull
public static java.util.Map<java.lang.String,java.lang.Object> convertObjectToMap(@NotNull
                                                                                            java.lang.Object object)

Converts the given object to a shallow map. The copy is only one layer deep, and is of all the fields in the object (private, static, public, etc...)

Parameters:

object - The object to convert to a map

Returns:

A map of object values

convertObjectToDeepMap

@NotNull
public static java.util.Map<java.lang.String,java.lang.Object> convertObjectToDeepMap(@NotNull
                                                                                                java.lang.Object object)

Converts the given object to a deep map. The copy goes until primitive types (or strings) are found

Parameters:

object - The object to convert to a map

Returns:

A map of object values

getBoxedType

@NotNull
public static java.lang.Class<?> getBoxedType(@NotNull
                                                        java.lang.Class<?> primitive)

Converts a primitive class to it corresponding boxed type

Parameters:

primitive - The class of the primitive

Returns:

The class of the boxed type