ReflectionUtils (icu.easyj :: easyj-core 0.7.5 API)

java.lang.Object
- icu.easyj.core.util.ReflectionUtils

public abstract class ReflectionUtils
extends Object

反射工具类

Author:: wangliang181230

Field Summary

Fields
Modifier and Type Field and Description

static Field NULL_FIELD
The NULL_FIELD

static Method NULL_METHOD
The NULL_METHOD

Fields
Modifier and Type	Field and Description
`static Field`	`NULL_FIELD` The NULL_FIELD
`static Method`	`NULL_METHOD` The NULL_METHOD

Constructor Summary

Constructors
Constructor and Description

ReflectionUtils()

Constructors
Constructor and Description
`ReflectionUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`annotationToString(Annotation annotation)` annotatio to string
`static String`	`classToString(Class<?> clazz)` class to string
`static boolean`	`containsMethod(Collection<Method> methods, Method method)` Contains method
`static boolean`	`containsMethod(Map<Method,?> methodMap, Method method)` Contains method
`static boolean`	`equalsMethod(Method m1, Method m2)` Equals method
`static String`	`fieldToString(Class<?> clazz, String fieldName, Class<?> fieldType)` field to string
`static String`	`fieldToString(Field field)` field to string
`static Field[]`	`getAllFields(Class<?> targetClazz)` Gets all fields, excluding static or synthetic fields
`static <T extends Annotation> T`	`getAnnotation(Method method, Class<T> annotationClass)` get annotation from the method or super class method
`static <T> T`	`getAnnotationValue(Annotation annotation, String fieldName)` get annotation value
`static Map<String,Object>`	`getAnnotationValues(Annotation annotation)` get annotation values
`static Class<?>`	`getClassByName(String className)` Gets class by name.
`static Class<?>`	`getClassByName(String className, ClassLoader loader)` Gets class by name.
`static Field`	`getField(Class<?> clazz, String fieldName)` get Field
`static <T> T`	`getFieldValue(Object target, Field field)` get field value
`static <T> T`	`getFieldValue(Object target, String fieldName)` get field value
`static Set<Class<?>>`	`getInterfaces(Class<?> clazz)` get all interface of the clazz
`static Method`	`getMethod(Class<?> clazz, String methodName)` get method
`static Method`	`getMethod(Class<?> clazz, String methodName, Class<?>... parameterTypes)` get method
`static <T> T`	`getSingleton(Class<T> clazz)` get singleton for the class
`static boolean`	`hasField(Class<?> clazz, String fieldName)` has Field
`static boolean`	`hasMethod(Class<?> clazz, Method method)` Has method
`static Object`	`invokeMethod(Object target, Method method)` invoke Method
`static Object`	`invokeMethod(Object target, Method method, Object... args)` invoke Method
`static Object`	`invokeMethod(Object target, String methodName)` invoke Method
`static Object`	`invokeMethod(Object target, String methodName, Class<?>[] parameterTypes, Object... args)` invoke Method
`static Object`	`invokeStaticMethod(Class<?> targetClass, String staticMethodName)` invoke static Method
`static Object`	`invokeStaticMethod(Class<?> targetClass, String staticMethodName, Class<?>[] parameterTypes, Object... args)` invoke static Method
`static Object`	`invokeStaticMethod(Method staticMethod)` invoke static Method
`static Object`	`invokeStaticMethod(Method staticMethod, Object... args)` invoke static Method
`static String`	`methodToString(Class<?> clazz, String methodName, Class<?>... parameterTypes)` method to string
`static String`	`methodToString(Method method)` method to string
`static String`	`parameterTypesToString(Class<?>[] parameterTypes)` parameter types to string
`static <T extends AccessibleObject> void`	`setAccessible(T accessible)` set accessible to true if false
`static void`	`setFieldValue(Object target, Field field, Object fieldValue)` set field value
`static void`	`setFieldValue(Object target, String fieldName, Object fieldValue)` get field value
`static void`	`setStaticFieldValue(Class<?> targetClass, String staticFieldName, Object newValue)` set `static` field value
`static void`	`setStaticFieldValue(Field staticField, Object newValue)` set `static` field value

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

Field Detail

NULL_FIELD
```
public static final Field NULL_FIELD
```
The NULL_FIELD

NULL_METHOD
```
public static final Method NULL_METHOD
```
The NULL_METHOD

Constructor Detail
- ReflectionUtils
```
public ReflectionUtils()
```

Method Detail

getClassByName

@NonNull
public static Class<?> getClassByName(String className,
                                               ClassLoader loader)
                                        throws ClassNotFoundException

Gets class by name.

Parameters:: className - the class name; loader - the class loader
Returns:: the class by name
Throws:: ClassNotFoundException - the class not found exception

getClassByName
```
@NonNull
public static Class<?> getClassByName(String className)
                                        throws ClassNotFoundException
```
Gets class by name.

Parameters:

className - the class name

Returns:

the class by name

Throws:

ClassNotFoundException - the class not found exception

getInterfaces
```
@NonNull
public static Set<Class<?>> getInterfaces(Class<?> clazz)
```
get all interface of the clazz

Parameters:

clazz - the clazz

Returns:

set

setAccessible
```
public static <T extends AccessibleObject> void setAccessible(T accessible)
                                                       throws SecurityException
```
set accessible to true if false

Type Parameters:

T - the type of the accessible

Parameters:

accessible - the accessible

Throws:

SecurityException - if the request is denied.

getAllFields
```
@NonNull
public static Field[] getAllFields(Class<?> targetClazz)
```
Gets all fields, excluding static or synthetic fields

Parameters:

targetClazz - the target class

Returns:

allFields the all fields

hasField

public static boolean hasField(Class<?> clazz,
                               String fieldName)

has Field

Parameters:: clazz - the class; fieldName - the field name
Returns:: the boolean

getField

@NonNull
public static Field getField(Class<?> clazz,
                                      String fieldName)
                               throws NoSuchFieldException,
                                      SecurityException

get Field

Parameters:: clazz - the class; fieldName - the field name
Returns:: the field
Throws:: IllegalArgumentException - if clazz or fieldName is null; NoSuchFieldException - if the field named fieldName does not exist; SecurityException - the security exception

getFieldValue

@Nullable
public static <T> T getFieldValue(Object target,
                                            Field field)
                                     throws IllegalArgumentException,
                                            SecurityException

get field value

Type Parameters:: T - the field type
Parameters:: target - the target; field - the field of the target
Returns:: field value
Throws:: IllegalArgumentException - if target is null; SecurityException - the security exception; ClassCastException - if the type of the variable receiving the field value is not equals to the field type

getFieldValue

@Nullable
public static <T> T getFieldValue(Object target,
                                            String fieldName)
                                     throws IllegalArgumentException,
                                            NoSuchFieldException,
                                            SecurityException

get field value

Type Parameters:: T - the field type
Parameters:: target - the target; fieldName - the field name
Returns:: field value
Throws:: IllegalArgumentException - if target or fieldName is null; NoSuchFieldException - if the field named fieldName does not exist; SecurityException - the security exception; ClassCastException - if the type of the variable receiving the field value is not equals to the field type

setFieldValue

public static void setFieldValue(Object target,
                                 Field field,
                                 Object fieldValue)
                          throws IllegalArgumentException,
                                 SecurityException

set field value

Parameters:: target - the target; field - the field of the target; fieldValue - the field value
Throws:: IllegalArgumentException - if target is null; SecurityException - the security exception

setFieldValue

public static void setFieldValue(Object target,
                                 String fieldName,
                                 Object fieldValue)
                          throws IllegalArgumentException,
                                 NoSuchFieldException,
                                 SecurityException

get field value

Parameters:: target - the target; fieldName - the field name; fieldValue - the field value
Throws:: IllegalArgumentException - if target or fieldName is null; NoSuchFieldException - if the field named fieldName does not exist; SecurityException - the security exception

setStaticFieldValue
```
public static void setStaticFieldValue(Field staticField,
                                       Object newValue)
                                throws IllegalAccessException
```
set `static` field value

Parameters:

staticField - the static field

newValue - the new value

Throws:

IllegalArgumentException - if staticField is null or not a static field

IllegalAccessException - the illegal access exception

setStaticFieldValue

public static void setStaticFieldValue(Class<?> targetClass,
                                       String staticFieldName,
                                       Object newValue)
                                throws NoSuchFieldException,
                                       IllegalAccessException

set `static` field value

Parameters:: targetClass - the target class; staticFieldName - the static field name; newValue - the new value
Throws:: IllegalArgumentException - if targetClass or staticFieldName is null; NullPointerException - if staticFieldName is null; NoSuchFieldException - if the field named modifyFieldName does not exist; IllegalAccessException - the illegal access exception

getMethod

@NonNull
public static Method getMethod(Class<?> clazz,
                                        String methodName,
                                        Class<?>... parameterTypes)
                                 throws NoSuchMethodException,
                                        SecurityException

get method

Parameters:: clazz - the class; methodName - the method name; parameterTypes - the parameter types
Returns:: the method
Throws:: IllegalArgumentException - if clazz is null; NullPointerException - if methodName is null; NoSuchMethodException - if the method named methodName does not exist; SecurityException - the security exception

getMethod

@NonNull
public static Method getMethod(Class<?> clazz,
                                        String methodName)
                                 throws NoSuchMethodException,
                                        SecurityException

get method

Parameters:: clazz - the class; methodName - the method name
Returns:: the method
Throws:: IllegalArgumentException - if clazz is null; NullPointerException - if methodName is null; NoSuchMethodException - if the method named methodName does not exist; SecurityException - the security exception

invokeMethod

public static Object invokeMethod(Object target,
                                  Method method,
                                  Object... args)
                           throws InvocationTargetException,
                                  IllegalArgumentException,
                                  SecurityException

invoke Method

Parameters:: target - the target; method - the method; args - the args
Returns:: the result of the underlying method
Throws:: InvocationTargetException - if the underlying method throws an exception.; IllegalArgumentException - the illegal argument exception; SecurityException - the security exception

invokeMethod

public static Object invokeMethod(Object target,
                                  Method method)
                           throws InvocationTargetException,
                                  IllegalArgumentException,
                                  SecurityException

invoke Method

Parameters:: target - the target; method - the method
Returns:: the result of the underlying method
Throws:: InvocationTargetException - if the underlying method throws an exception.; IllegalArgumentException - the illegal argument exception; SecurityException - the security exception

invokeMethod

public static Object invokeMethod(Object target,
                                  String methodName,
                                  Class<?>[] parameterTypes,
                                  Object... args)
                           throws NoSuchMethodException,
                                  InvocationTargetException,
                                  IllegalArgumentException,
                                  SecurityException

invoke Method

Parameters:: target - the target; methodName - the method name; parameterTypes - the parameter types; args - the args
Returns:: the result of the underlying method
Throws:: IllegalArgumentException - if target is null; NullPointerException - if methodName is null; NoSuchMethodException - if the method named methodName does not exist; InvocationTargetException - if the underlying method throws an exception.; SecurityException - the security exception

invokeMethod

public static Object invokeMethod(Object target,
                                  String methodName)
                           throws NoSuchMethodException,
                                  InvocationTargetException,
                                  IllegalArgumentException,
                                  SecurityException

invoke Method

Parameters:: target - the target; methodName - the method name
Returns:: the result of the underlying method
Throws:: NoSuchMethodException - the no such method exception; InvocationTargetException - if the underlying method throws an exception.; IllegalArgumentException - the illegal argument exception; SecurityException - the security exception

invokeStaticMethod

public static Object invokeStaticMethod(Method staticMethod,
                                        Object... args)
                                 throws IllegalArgumentException,
                                        InvocationTargetException,
                                        SecurityException

invoke static Method

Parameters:: staticMethod - the static method; args - the args
Returns:: the result of the static method
Throws:: IllegalArgumentException - if staticMethod is null or not a static method; InvocationTargetException - if the underlying method throws an exception.; SecurityException - the security exception

invokeStaticMethod

public static Object invokeStaticMethod(Method staticMethod)
                                 throws InvocationTargetException,
                                        IllegalArgumentException,
                                        SecurityException

invoke static Method

Parameters:: staticMethod - the static method
Returns:: the result of the static method
Throws:: InvocationTargetException - if the underlying method throws an exception.; IllegalArgumentException - the illegal argument exception; SecurityException - the security exception

invokeStaticMethod

public static Object invokeStaticMethod(Class<?> targetClass,
                                        String staticMethodName,
                                        Class<?>[] parameterTypes,
                                        Object... args)
                                 throws IllegalArgumentException,
                                        NoSuchMethodException,
                                        InvocationTargetException,
                                        SecurityException

invoke static Method

Parameters:: targetClass - the target class; staticMethodName - the static method name; parameterTypes - the parameter types; args - the args
Returns:: the result of the static method
Throws:: IllegalArgumentException - if targetClass is null; NullPointerException - if methodName is null; NoSuchMethodException - the no such method exception; InvocationTargetException - if the underlying method throws an exception.; SecurityException - the security exception

invokeStaticMethod

public static Object invokeStaticMethod(Class<?> targetClass,
                                        String staticMethodName)
                                 throws IllegalArgumentException,
                                        NoSuchMethodException,
                                        SecurityException,
                                        InvocationTargetException

invoke static Method

Parameters:: targetClass - the target class; staticMethodName - the static method name
Returns:: the result of the static method
Throws:: IllegalArgumentException - if targetClass is null; NullPointerException - if methodName is null; NoSuchMethodException - the no such method exception; InvocationTargetException - if the underlying method throws an exception.; SecurityException - the security exception

equalsMethod

public static boolean equalsMethod(Method m1,
                                   Method m2)

Equals method

Parameters:: m1 - the method 1; m2 - the method 2
Returns:: the boolean

containsMethod

public static boolean containsMethod(Collection<Method> methods,
                                     Method method)

Contains method

Parameters:: methods - the methods; method - the method
Returns:: the boolean

containsMethod

public static boolean containsMethod(Map<Method,?> methodMap,
                                     Method method)

Contains method

Parameters:: methodMap - the method map; method - the method
Returns:: the boolean

hasMethod

public static boolean hasMethod(Class<?> clazz,
                                Method method)

Has method

Parameters:: clazz - the class; method - the method
Returns:: the boolean

getAnnotation

@Nullable
public static <T extends Annotation> T getAnnotation(Method method,
                                                               Class<T> annotationClass)

get annotation from the method or super class method

Type Parameters:: T - the annotation type
Parameters:: method - the method; annotationClass - the annotation class
Returns:: the annotation

getAnnotationValues
```
@NonNull
public static Map<String,Object> getAnnotationValues(Annotation annotation)
                                                       throws NoSuchFieldException
```
get annotation values

Parameters:

annotation - the annotation

Returns:

annotationValues the annotation values

Throws:

IllegalArgumentException - if annotation is null

NoSuchFieldException - the no such field exception

getAnnotationValue
```
@Nullable
public static <T> T getAnnotationValue(Annotation annotation,
                                                 String fieldName)
                                          throws NoSuchFieldException
```
get annotation value

Type Parameters:

T - the type of the field

Parameters:

annotation - the annotation

fieldName - the field name

Returns:

annotationValue the field value

Throws:

IllegalArgumentException - if annotation or fieldName is null

NoSuchFieldException - the no such field exception

getSingleton
```
@NonNull
public static <T> T getSingleton(Class<T> clazz)
```
get singleton for the class

Type Parameters:

T - the type

Parameters:

clazz - the clazz

Returns:

the singleton

Throws:

IllegalArgumentException - if clazz is null

classToString
```
public static String classToString(Class<?> clazz)
```
class to string

Parameters:

clazz - the class

Returns:

the string

fieldToString

public static String fieldToString(Class<?> clazz,
                                   String fieldName,
                                   Class<?> fieldType)

field to string

Parameters:: clazz - the clazz; fieldName - the field name; fieldType - the field type
Returns:: the string

fieldToString
```
public static String fieldToString(Field field)
```
field to string

Parameters:

field - the field

Returns:

the string

methodToString

public static String methodToString(Class<?> clazz,
                                    String methodName,
                                    Class<?>... parameterTypes)

method to string

Parameters:: clazz - the clazz; methodName - the method name; parameterTypes - the parameter types
Returns:: the string

methodToString
```
public static String methodToString(Method method)
```
method to string

Parameters:

method - the method

Returns:

the string

annotationToString
```
public static String annotationToString(Annotation annotation)
```
annotatio to string

Parameters:

annotation - the annotation

Returns:

the string

parameterTypesToString
```
public static String parameterTypesToString(Class<?>[] parameterTypes)
```
parameter types to string

Parameters:

parameterTypes - the parameter types

Returns:

the string

Class ReflectionUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL_FIELD

NULL_METHOD

Constructor Detail

ReflectionUtils

Method Detail

getClassByName

getClassByName

getInterfaces

setAccessible

getAllFields

hasField

getField

getFieldValue

getFieldValue

setFieldValue

setFieldValue

setStaticFieldValue

setStaticFieldValue

getMethod

getMethod

invokeMethod

invokeMethod

invokeMethod

invokeMethod

invokeStaticMethod

invokeStaticMethod

invokeStaticMethod

invokeStaticMethod

equalsMethod

containsMethod

containsMethod

hasMethod

getAnnotation

getAnnotationValues

getAnnotationValue

getSingleton

classToString

fieldToString

fieldToString

methodToString

methodToString

annotationToString

parameterTypesToString