de.alpharogroup.reflection

Class ReflectionExtensions

java.lang.Object

de.alpharogroup.reflection.ReflectionExtensions

public final class ReflectionExtensions
extends Object

The class ReflectionExtensions provides utility methods for the java reflection API

Constructor Summary

Constructors

Constructor and Description
ReflectionExtensions()

Method Summary

Modifier and Type	Method and Description
static <T> void	copyFieldValue(T source, T target, @NonNull String fieldName) Copies the field value of the given source object to the given target object.
static String	firstCharacterToUpperCase(@NonNull String fieldName) Sets the first character from the given string to upper case and returns it.
static String[]	getAllDeclaredFieldNames(@NonNull Class<?> cls) Gets all the declared field names including all fields from all super classes from the given class object
static String[]	getAllDeclaredFieldNames(@NonNull Class<?> cls, List<String> ignoreFieldNames) Gets all the declared field names including all fields from all super classes from the given class object minus the given ignored field names
static String[]	getAllDeclaredFieldNames(@NonNull Class<?> cls, String... ignoreFieldNames) Gets all the declared field names including all fields from all super classes from the given class object minus the given optional array of ignored field names
static Field[]	getAllDeclaredFields(@NonNull Class<?> cls) Gets all the declared fields including all fields from all super classes from the given class object
static Field	getDeclaredField(@NonNull Class<?> cls, @NonNull String fieldName) Gets the Field that match to the given field name that exists in the given class.
static <T> Field	getDeclaredField(T object, @NonNull String fieldName) Gets the Field that match to the given field name that exists in the given object.
static String[]	getDeclaredFieldNames(@NonNull Class<?> cls) Gets all the declared field names from the given class object.
static String[]	getDeclaredFieldNames(@NonNull Class<?> cls, List<String> ignoreFieldNames) Gets all the declared field names from the given class object minus the given ignored field names Note: without the field names from any superclasses
static String[]	getDeclaredFieldNames(@NonNull Class<?> cls, String... ignoreFieldNames) Gets all the declared field names from the given class object minus the given ignored field names Note: without the field names from any superclasses
static Field[]	getDeclaredFields(@NonNull Class<?> cls, List<String> ignoreFieldNames) Gets the declared fields from the given class minus the given ignored field names
static Field[]	getDeclaredFields(@NonNull Class<?> cls, String... ignoreFieldNames) Gets the declared fields from the given class minus the given optional array of ignored field names
static List<String>	getFieldNames(@NonNull Class<?> cls) Gets all field names from the given class as an String list.
static List<String>	getFieldNames(@NonNull Class<?> cls, List<String> ignoreFieldNames) Gets all field names from the given class as an String list minus the given ignored field names
static List<String>	getFieldNames(@NonNull Class<?> cls, String... ignoreFieldNames) Gets all field names from the given class as an String list minus the given optional array of ignored field names
static <T> Object	getFieldValue(T source, @NonNull String fieldName) Gets the field value of the given source object over the field name.
static String[]	getMethodNames(@NonNull Class<?> cls) Gets all method names from the given class as an String array.
static Map<String,String>	getMethodNamesWithPrefixFromFieldNames(@NonNull List<String> fieldNames, String prefix) Generates a Map with the fieldName as key and the method as value.
static List<String>	getModifiers(@NonNull Field field) Gets the modifiers from the given Field as a list of String objects.
static boolean	isNotSynthetic(@NonNull Field field) Checks if the given Field is not synthetic
static <T> T	newInstance(@NonNull Class<T> clazz) Creates a new instance from the same type as the given Class.
static <T> T	newInstance(T object) Creates a new instance from the same type as the given object.
static <T> T	newInstanceWithObjenesis(@NonNull Class<T> clazz) Creates a new instance from the same type as the given Class
static <T> void	setFieldValue(@NonNull Class<?> cls, @NonNull String fieldName, Object newValue) Sets the field value of the given class object over the field name.
static <T> void	setFieldValue(T source, @NonNull String fieldName, Object newValue) Sets the field value of the given source object over the field name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReflectionExtensions

public ReflectionExtensions()

Method Detail

copyFieldValue

public static <T> void copyFieldValue(@NonNull
                                      T source,
                                      @NonNull
                                      T target,
                                      @NonNull
                                      @NonNull String fieldName)
                               throws NoSuchFieldException,
                                      SecurityException,
                                      IllegalAccessException

Copies the field value of the given source object to the given target object.

Type Parameters:

T - the generic type of the object

Parameters:

source - the source

target - the target

fieldName - the field name

Throws:

NoSuchFieldException - is thrown if no such field exists.

SecurityException - is thrown if a security manager says no.

IllegalAccessException - is thrown if an illegal on create an instance or access a method.

setFieldValue

public static <T> void setFieldValue(@NonNull
                                     T source,
                                     @NonNull
                                     @NonNull String fieldName,
                                     Object newValue)
                              throws NoSuchFieldException,
                                     SecurityException,
                                     IllegalAccessException

Sets the field value of the given source object over the field name.

Type Parameters:

T - the generic type

Parameters:

source - the source

fieldName - the field name

newValue - the new value

Throws:

NoSuchFieldException - is thrown if no such field exists.

SecurityException - is thrown if a security manager says no.

IllegalAccessException - is thrown if an illegal on create an instance or access a method.

getFieldValue

public static <T> Object getFieldValue(@NonNull
                                       T source,
                                       @NonNull
                                       @NonNull String fieldName)
                                throws NoSuchFieldException,
                                       SecurityException,
                                       IllegalAccessException

Gets the field value of the given source object over the field name.

Type Parameters:

T - the generic type

Parameters:

source - the source

fieldName - the field name

Returns:

the field value

Throws:

NoSuchFieldException - is thrown if no such field exists.

SecurityException - is thrown if a security manager says no.

IllegalAccessException - is thrown if an illegal on create an instance or access a method.

setFieldValue

public static <T> void setFieldValue(@NonNull
                                     @NonNull Class<?> cls,
                                     @NonNull
                                     @NonNull String fieldName,
                                     Object newValue)
                              throws NoSuchFieldException,
                                     SecurityException,
                                     IllegalAccessException

Sets the field value of the given class object over the field name.

Type Parameters:

T - the generic type

Parameters:

cls - The class

fieldName - the field name

newValue - the new value

Throws:

NoSuchFieldException - is thrown if no such field exists.

SecurityException - is thrown if a security manager says no.

IllegalAccessException - is thrown if an illegal on create an instance or access a method.

getFieldNames

public static List<String> getFieldNames(@NonNull
                                         @NonNull Class<?> cls)

Gets all field names from the given class as an String list.

Parameters:

cls - The class object to get the field names.

Returns:

Gets all field names from the given class as an String list.

getFieldNames

public static List<String> getFieldNames(@NonNull
                                         @NonNull Class<?> cls,
                                         List<String> ignoreFieldNames)

Gets all field names from the given class as an String list minus the given ignored field names

Parameters:

cls - The class object to get the field names

ignoreFieldNames - a list with field names that shell be ignored

Returns:

Gets all field names from the given class as an String list minus the given ignored field names

getFieldNames

public static List<String> getFieldNames(@NonNull
                                         @NonNull Class<?> cls,
                                         String... ignoreFieldNames)

Gets all field names from the given class as an String list minus the given optional array of ignored field names

Parameters:

cls - The class object to get the field names

ignoreFieldNames - a optional array with the field names that shell be ignored

Returns:

Gets all field names from the given class as an String list minus the given optional array of ignored field names

getDeclaredFieldNames

public static String[] getDeclaredFieldNames(@NonNull
                                             @NonNull Class<?> cls)

Gets all the declared field names from the given class object. Note: without the field names from any superclasses

Parameters:

cls - the class object

Returns:

all the declared field names from the given class as an String array

getDeclaredFieldNames

public static String[] getDeclaredFieldNames(@NonNull
                                             @NonNull Class<?> cls,
                                             String... ignoreFieldNames)

Gets all the declared field names from the given class object minus the given ignored field names Note: without the field names from any superclasses

Parameters:

cls - the class object

ignoreFieldNames - a optional array with the field names that shell be ignored

Returns:

all the declared field names from the given class as an String array minus the given optional array of ignored field names

getDeclaredFieldNames

public static String[] getDeclaredFieldNames(@NonNull
                                             @NonNull Class<?> cls,
                                             List<String> ignoreFieldNames)

Gets all the declared field names from the given class object minus the given ignored field names Note: without the field names from any superclasses

Parameters:

cls - the class object

ignoreFieldNames - a list with field names that shell be ignored

Returns:

all the declared field names from the given class as an String array minus the given ignored field names

isNotSynthetic

public static boolean isNotSynthetic(@NonNull
                                     @NonNull Field field)

Checks if the given Field is not synthetic

Parameters:

field - the field

Returns:

true, if the given Field is not synthetic otherwise false

getMethodNames

public static String[] getMethodNames(@NonNull
                                      @NonNull Class<?> cls)

Gets all method names from the given class as an String array.

Parameters:

cls - The class object to get the method names.

Returns:

Gets all method names from the given class as an String array.

getMethodNamesWithPrefixFromFieldNames

public static Map<String,String> getMethodNamesWithPrefixFromFieldNames(@NonNull
                                                                        @NonNull List<String> fieldNames,
                                                                        String prefix)

Generates a Map with the fieldName as key and the method as value. Concatenates the given prefix and the field name and puts the result into the map.

Parameters:

fieldNames - A list with the field names.

prefix - The prefix for the method name.

Returns:

the method names with prefix from field names

firstCharacterToUpperCase

public static String firstCharacterToUpperCase(@NonNull
                                               @NonNull String fieldName)

Sets the first character from the given string to upper case and returns it. Example:
Given fieldName: userName
Result: UserName

Parameters:

fieldName - The String to modify.

Returns:

The modified string.

getModifiers

public static List<String> getModifiers(@NonNull
                                        @NonNull Field field)

Gets the modifiers from the given Field as a list of String objects.

Parameters:

field - The field to get the modifiers.

Returns:

A list with the modifiers as String objects from the given Field.

newInstance

public static <T> T newInstance(@NonNull
                                T object)
                         throws InstantiationException,
                                IllegalAccessException,
                                ClassNotFoundException

Creates a new instance from the same type as the given object.

Type Parameters:

T - the generic type

Parameters:

object - the object

Returns:

the new instance

Throws:

ClassNotFoundException - is thrown if the class cannot be located

IllegalAccessException - is thrown if the class or its default constructor is not accessible.

InstantiationException - is thrown if this Class represents an abstract class, an interface, an array class, a primitive type, or void; or if the class has no default constructor; or if the instantiation fails for some other reason.

newInstance

public static <T> T newInstance(@NonNull
                                @NonNull Class<T> clazz)
                         throws InstantiationException,
                                IllegalAccessException

Creates a new instance from the same type as the given Class.

Type Parameters:

T - the generic type

Parameters:

clazz - the Class object

Returns:

the new instance

Throws:

IllegalAccessException - is thrown if the class or its default constructor is not accessible.

InstantiationException - is thrown if this Class represents an abstract class, an interface, an array class, a primitive type, or void; or if the class has no default constructor; or if the instantiation fails for some other reason.

newInstanceWithObjenesis

public static <T> T newInstanceWithObjenesis(@NonNull
                                             @NonNull Class<T> clazz)

Creates a new instance from the same type as the given Class

Type Parameters:

T - the generic type

Parameters:

clazz - the Class object

Returns:

the new instance

getDeclaredField

public static <T> Field getDeclaredField(@NonNull
                                         T object,
                                         @NonNull
                                         @NonNull String fieldName)
                                  throws NoSuchFieldException,
                                         SecurityException

Gets the Field that match to the given field name that exists in the given object.

Type Parameters:

T - the generic type

Parameters:

object - the object

fieldName - the field name

Returns:

the declared field

Throws:

NoSuchFieldException - is thrown if no such field exists.

SecurityException - is thrown if a security manager says no.

getDeclaredField

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

Gets the Field that match to the given field name that exists in the given class.

Parameters:

cls - the class object

fieldName - the field name

Returns:

the declared field

Throws:

NoSuchFieldException - is thrown if no such field exists.

SecurityException - is thrown if a security manager says no.

getAllDeclaredFields

public static Field[] getAllDeclaredFields(@NonNull
                                           @NonNull Class<?> cls)

Gets all the declared fields including all fields from all super classes from the given class object

Parameters:

cls - the class object

Returns:

all the declared fields

getAllDeclaredFieldNames

public static String[] getAllDeclaredFieldNames(@NonNull
                                                @NonNull Class<?> cls)

Gets all the declared field names including all fields from all super classes from the given class object

Parameters:

cls - the class object

Returns:

all the declared field names

getAllDeclaredFieldNames

public static String[] getAllDeclaredFieldNames(@NonNull
                                                @NonNull Class<?> cls,
                                                String... ignoreFieldNames)

Gets all the declared field names including all fields from all super classes from the given class object minus the given optional array of ignored field names

Parameters:

cls - the class object

ignoreFieldNames - a optional array with the field names that shell be ignored

Returns:

all the declared field names minus the given optional array of ignored field names

getAllDeclaredFieldNames

public static String[] getAllDeclaredFieldNames(@NonNull
                                                @NonNull Class<?> cls,
                                                List<String> ignoreFieldNames)

Gets all the declared field names including all fields from all super classes from the given class object minus the given ignored field names

Parameters:

cls - the class object

ignoreFieldNames - a list with field names that shell be ignored

Returns:

all the declared field names minus the given ignored field names

getDeclaredFields

public static Field[] getDeclaredFields(@NonNull
                                        @NonNull Class<?> cls,
                                        List<String> ignoreFieldNames)
                                 throws SecurityException

Gets the declared fields from the given class minus the given ignored field names

Parameters:

cls - the class object

ignoreFieldNames - a list with field names that shell be ignored

Returns:

the declared Field from the given class minus the given ignored field names

Throws:

SecurityException - is thrown if a security manager says no

getDeclaredFields

public static Field[] getDeclaredFields(@NonNull
                                        @NonNull Class<?> cls,
                                        String... ignoreFieldNames)
                                 throws SecurityException

Gets the declared fields from the given class minus the given optional array of ignored field names

Parameters:

cls - the class object

ignoreFieldNames - a list with field names that shell be ignored

Returns:

the declared Field from the given class minus the given optional array of ignored field names

Throws:

SecurityException - is thrown if a security manager says no