com.varra.util

Class ReflectUtil

java.lang.Object

com.varra.util.ReflectUtil

public class ReflectUtil
extends Object

Various java.lang.reflect utilities.

Version:

1.0

Author:

Rajakrishna V. Reddy

Field Summary

Fields

Modifier and Type	Field and Description
static String	METHOD_GET_PREFIX The Constant METHOD_GET_PREFIX.
static String	METHOD_IS_PREFIX The Constant METHOD_IS_PREFIX.
static String	METHOD_SET_PREFIX The Constant METHOD_SET_PREFIX.
static Object[]	NO_ARGUMENTS an empty object array.
static Class[]	NO_PARAMETERS an empty class array.
static Type[]	NO_TYPES an empty object array.

Constructor Summary

Constructors

Constructor and Description
ReflectUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	compareDeclarations(Method first, Method second) Compares method declarations: signature and return types.
static boolean	compareParameters(Class[] first, Class[] second) Compares method or ctor parameters.
static boolean	compareSignatures(Constructor first, Constructor second) Compares constructor signatures: names and parameters.
static boolean	compareSignatures(Field first, Field second) Compare signatures.
static boolean	compareSignatures(Method first, Method second) Compares method signatures: names and parameters.
static <T,V> V	executeMethod(T type, String methodName, boolean equalsIgnoreCase, Object... args) Finds the method based on the name provided and executes the method by passing the arguments.
static <T,V> V	executeMethod(T type, String methodName, boolean equalsIgnoreCase, String... args) Finds the method based on the name provided and executes the method by passing the arguments.
static Method	findDeclaredMethod(Class c, String methodName) Find declared method.
static Method	findMethod(Class c, String methodName) Returns method from an object, matched by name.
static void	forceAccess(AccessibleObject accObject) Suppress access check against a reflection object.
static Field[]	getAccessibleFields(Class clazz) Gets the accessible fields.
static Field[]	getAccessibleFields(Class clazz, Class limit) Gets the accessible fields.
static Method[]	getAccessibleMethods(Class clazz) Returns array of all methods that are accessible from given class.
static Method[]	getAccessibleMethods(Class clazz, Class limit) Returns array of all methods that are accessible from given class, upto limit (usually Object.class).
static String	getBeanPropertyGetterName(Method method) Returns beans property getter name or null if method is not a real getter.
static String	getBeanPropertySetterName(Method method) Returns beans property setter name or null if method is not a real setter.
static Class[]	getClasses(Object... objects) Returns classes from array of specified objects.
static Class	getComponentType(Type type) Returns component type of the given type.
static Class	getComponentType(Type type, int index) Returns the component type of the given type. For example the following types all have the component-type MyClass: MyClass[] List<MyClass> Foo<? extends MyClass> Bar<? super MyClass> <T extends MyClass> T[]
static <T> Field	getDeclaredField(T type, String name, boolean equalsIgnoreCase) Gets the declared field.
static <T> Method	getDeclaredMethod(T type, String methodName, boolean equalsIgnoreCase) Gets the declared method.
static <T> String	getFieldName(Class<T> type, String name, boolean equalsIgnoreCase) Gets the declared field name as String.
static <T> String	getFieldName(T type, String name, boolean equalsIgnoreCase) Gets the declared field name as String.
static <T,V> V	getFieldValue(T type, String name, boolean equalsIgnoreCase) Gets the field value.
static Class	getGenericSupertype(Class type) Gets the generic supertype.
static Class	getGenericSupertype(Class type, int index) Gets the generic supertype.
static Method	getMethod0(Class c, String name, Class... parameterTypes) Invokes private Class.getMethod0() without throwing NoSuchMethodException.
static <T> List<String>	getMethodsThatHas(T type, Class<? extends Annotation> annotation) Gets the methods that has.
static Class[]	getSuperclasses(Class type) Returns all superclasses.
static Field[]	getSupportedFields(Class clazz) Gets the supported fields.
static Field[]	getSupportedFields(Class clazz, Class limit) Gets the supported fields.
static Method[]	getSupportedMethods(Class clazz) Gets the supported methods.
static Method[]	getSupportedMethods(Class clazz, Class limit) Returns a Method array of the methods to which instances of the specified respond except for those methods defined in the class specified by limit or any of its superclasses.
static <T> boolean	has(T type, String methodName, boolean equalsIgnoreCase, Class<? extends Annotation> annotation) Checks the method for the given type of annotation, whether it contains it.
static Object	invoke(Class c, Object obj, String method, Class[] paramClasses, Object[] params) Invokes accessible method of an object.
static Object	invoke(Class c, Object obj, String method, Object[] params) Invoke.
static Object	invoke(Object obj, String method, Class[] paramClasses, Object[] params) Invokes accessible method of an object.
static Object	invoke(Object obj, String method, Object[] params) Invokes accessible method of an object without specifying parameter types.
static Object	invokeDeclared(Class c, Object obj, String method, Class[] paramClasses, Object[] params) Invokes any method of a class, even private ones.
static Object	invokeDeclared(Class c, Object obj, String method, Object[] params) Invoke declared.
static Object	invokeDeclared(Object obj, String method, Class[] paramClasses, Object[] params) Invokes any method of a class suppressing java access checking.
static Object	invokeDeclared(Object obj, String method, Object[] params) Invoke declared.
static boolean	isAssignableFrom(Member member1, Member member2) Returns true if the first member is accessible from second one.
static boolean	isBeanProperty(Method method) Returns true if method is a bean property.
static boolean	isBeanPropertyGetter(Method method) Returns true if method is bean getter.
static boolean	isBeanPropertySetter(Method method) Returns true if method is bean setter.
static boolean	isInstanceOf(Object o, Class target) Dynamic version of instanceof.
static boolean	isInterfaceImpl(Class thisClass, Class targetInterface) Returns true if provided class is interface implementation.
static boolean	isObjectMethod(Method method) Returns true if method defined in Object class.
static boolean	isPublic(Class c) Returns true if class is public.
static boolean	isPublic(Member member) Returns true if class member is public.
static boolean	isPublicPublic(Member member) Returns true if class member is public and if its declaring class is also public.
static boolean	isSubclass(Class thisClass, Class target) Determines if first class match the destination and simulates kind of instanceof.
static boolean	isUserDefinedMethod(Method method) Returns true if method is user defined and not defined in Object class.
static Object	newInstance(Class type) Creates new instances including for common mutable classes that do not have a default constructor.
static Object	readAnnotationValue(Annotation annotation, String name) Reads annotation value.
static <T> boolean	setFieldValue(T type, String name, String value) Sets the field value by converting the string type of value to the required type of the field.
static <T,V> void	setFieldValue(T type, String name, V value) Sets the field value.
static Class	toClass(Type type) Returns Class for the given type. Examples: typegetSimpleType(type)StringStringList<String>List<T extends MyClass> T[]MyClass[] Methods inherited from class java.lang.Object equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait Field Detail NO_PARAMETERS public static final Class[] NO_PARAMETERS an empty class array. NO_ARGUMENTS public static final Object[] NO_ARGUMENTS an empty object array. NO_TYPES public static final Type[] NO_TYPES an empty object array. METHOD_GET_PREFIX public static final String METHOD_GET_PREFIX The Constant METHOD_GET_PREFIX. See Also: Constant Field Values METHOD_IS_PREFIX public static final String METHOD_IS_PREFIX The Constant METHOD_IS_PREFIX. See Also: Constant Field Values METHOD_SET_PREFIX public static final String METHOD_SET_PREFIX The Constant METHOD_SET_PREFIX. See Also: Constant Field Values Constructor Detail ReflectUtil public ReflectUtil() Method Detail getMethod0 public static Method getMethod0(Class c, String name, Class... parameterTypes) Invokes private Class.getMethod0() without throwing NoSuchMethodException. Returns only public methods or null if method not found. Since no exception is throwing, it works faster. Parameters: c - class to inspect name - name of method to find parameterTypes - parameter types Returns: founded method, or null findMethod public static Method findMethod(Class c, String methodName) Returns method from an object, matched by name. This may be considered as a slow operation, since methods are matched one by one. Returns only accessible methods. Only first method is matched. Parameters: c - class to examine methodName - Full name of the method. Returns: null if method not found findDeclaredMethod public static Method findDeclaredMethod(Class c, String methodName) Find declared method. Parameters: c - the c methodName - the method name Returns: the method getClasses public static Class[] getClasses(Object... objects) Returns classes from array of specified objects. Parameters: objects - the objects Returns: the classes invoke public static Object invoke(Class c, Object obj, String method, Class[] paramClasses, Object[] params) throws IllegalAccessException, NoSuchMethodException, InvocationTargetException Invokes accessible method of an object. Parameters: c - class that contains method obj - object to execute method - method to invoke paramClasses - classes of parameters params - parameters � Returns: the object Throws: IllegalAccessException - the illegal access exception NoSuchMethodException - the no such method exception InvocationTargetException - the invocation target exception invoke public static Object invoke(Object obj, String method, Class[] paramClasses, Object[] params) throws IllegalAccessException, NoSuchMethodException, InvocationTargetException Invokes accessible method of an object. Parameters: obj - object method - name of the objects method paramClasses - method parameter types params - method parameters Returns: the object Throws: IllegalAccessException - the illegal access exception NoSuchMethodException - the no such method exception InvocationTargetException - the invocation target exception invoke public static Object invoke(Object obj, String method, Object[] params) throws IllegalAccessException, NoSuchMethodException, InvocationTargetException Invokes accessible method of an object without specifying parameter types. Parameters: obj - object method - method of an object params - method parameters Returns: the object Throws: IllegalAccessException - the illegal access exception NoSuchMethodException - the no such method exception InvocationTargetException - the invocation target exception invoke public static Object invoke(Class c, Object obj, String method, Object[] params) throws IllegalAccessException, NoSuchMethodException, InvocationTargetException Invoke. Parameters: c - the c obj - the obj method - the method params - the params Returns: the object Throws: IllegalAccessException - the illegal access exception NoSuchMethodException - the no such method exception InvocationTargetException - the invocation target exception invokeDeclared public static Object invokeDeclared(Class c, Object obj, String method, Class[] paramClasses, Object[] params) throws IllegalAccessException, NoSuchMethodException, InvocationTargetException Invokes any method of a class, even private ones. Parameters: c - class to examine obj - object to inspect method - method to invoke paramClasses - parameter types params - parameters Returns: the object Throws: IllegalAccessException - the illegal access exception NoSuchMethodException - the no such method exception InvocationTargetException - the invocation target exception invokeDeclared public static Object invokeDeclared(Object obj, String method, Class[] paramClasses, Object[] params) throws IllegalAccessException, NoSuchMethodException, InvocationTargetException Invokes any method of a class suppressing java access checking. Parameters: obj - object to inspect method - method to invoke paramClasses - parameter types params - parameters Returns: the object Throws: IllegalAccessException - the illegal access exception NoSuchMethodException - the no such method exception InvocationTargetException - the invocation target exception invokeDeclared public static Object invokeDeclared(Object obj, String method, Object[] params) throws IllegalAccessException, NoSuchMethodException, InvocationTargetException Invoke declared. Parameters: obj - the obj method - the method params - the params Returns: the object Throws: IllegalAccessException - the illegal access exception NoSuchMethodException - the no such method exception InvocationTargetException - the invocation target exception invokeDeclared public static Object invokeDeclared(Class c, Object obj, String method, Object[] params) throws IllegalAccessException, NoSuchMethodException, InvocationTargetException Invoke declared. Parameters: c - the c obj - the obj method - the method params - the params Returns: the object Throws: IllegalAccessException - the illegal access exception NoSuchMethodException - the no such method exception InvocationTargetException - the invocation target exception isSubclass public static boolean isSubclass(Class thisClass, Class target) Determines if first class match the destination and simulates kind of instanceof. All subclasses and interface of first class are examined against second class. Method is not symmetric. Parameters: thisClass - the this class target - the target Returns: true, if is subclass isInterfaceImpl public static boolean isInterfaceImpl(Class thisClass, Class targetInterface) Returns true if provided class is interface implementation. Parameters: thisClass - the this class targetInterface - the target interface Returns: true, if is interface impl isInstanceOf public static boolean isInstanceOf(Object o, Class target) Dynamic version of instanceof. Parameters: o - object to match target - target class Returns: true if object is an instance of target class getAccessibleMethods public static Method[] getAccessibleMethods(Class clazz) Returns array of all methods that are accessible from given class. Parameters: clazz - the clazz Returns: the accessible methods See Also: getAccessibleMethods(Class, Class) getAccessibleMethods public static Method[] getAccessibleMethods(Class clazz, Class limit) Returns array of all methods that are accessible from given class, upto limit (usually Object.class). Abstract methods are ignored. Parameters: clazz - the clazz limit - the limit Returns: the accessible methods getAccessibleFields public static Field[] getAccessibleFields(Class clazz) Gets the accessible fields. Parameters: clazz - the clazz Returns: the accessible fields getAccessibleFields public static Field[] getAccessibleFields(Class clazz, Class limit) Gets the accessible fields. Parameters: clazz - the clazz limit - the limit Returns: the accessible fields getSupportedMethods public static Method[] getSupportedMethods(Class clazz) Gets the supported methods. Parameters: clazz - the clazz Returns: the supported methods getSupportedMethods public static Method[] getSupportedMethods(Class clazz, Class limit) Returns a Method array of the methods to which instances of the specified respond except for those methods defined in the class specified by limit or any of its superclasses. Note that limit is usually used to eliminate them methods defined by java.lang.Object. If limit is null then all methods are returned. Parameters: clazz - the clazz limit - the limit Returns: the supported methods getSupportedFields public static Field[] getSupportedFields(Class clazz) Gets the supported fields. Parameters: clazz - the clazz Returns: the supported fields getSupportedFields public static Field[] getSupportedFields(Class clazz, Class limit) Gets the supported fields. Parameters: clazz - the clazz limit - the limit Returns: the supported fields compareDeclarations public static boolean compareDeclarations(Method first, Method second) Compares method declarations: signature and return types. Parameters: first - the first second - the second Returns: true, if successful compareSignatures public static boolean compareSignatures(Method first, Method second) Compares method signatures: names and parameters. Parameters: first - the first second - the second Returns: true, if successful compareSignatures public static boolean compareSignatures(Constructor first, Constructor second) Compares constructor signatures: names and parameters. Parameters: first - the first second - the second Returns: true, if successful compareSignatures public static boolean compareSignatures(Field first, Field second) Compare signatures. Parameters: first - the first second - the second Returns: true, if successful compareParameters public static boolean compareParameters(Class[] first, Class[] second) Compares method or ctor parameters. Parameters: first - the first second - the second Returns: true, if successful forceAccess public static void forceAccess(AccessibleObject accObject) Suppress access check against a reflection object. SecurityException is silently ignored. Checks first if the object is already accessible. Parameters: accObject - the acc object isPublic public static boolean isPublic(Member member) Returns true if class member is public. Parameters: member - the member Returns: true, if is public isPublicPublic public static boolean isPublicPublic(Member member) Returns true if class member is public and if its declaring class is also public. Parameters: member - the member Returns: true, if is public public isPublic public static boolean isPublic(Class c) Returns true if class is public. Parameters: c - the c Returns: true, if is public newInstance public static Object newInstance(Class type) throws IllegalAccessException, InstantiationException Creates new instances including for common mutable classes that do not have a default constructor. more user-friendly. It examines if class is a map, list, String, Character, Boolean or a Number. Immutable instances are cached and not created again. Arrays are also created with no elements. Note that this bunch of ifs is faster then a hashmap. Parameters: type - the type Returns: the object Throws: IllegalAccessException - the illegal access exception InstantiationException - the instantiation exception isAssignableFrom public static boolean isAssignableFrom(Member member1, Member member2) Returns true if the first member is accessible from second one. Parameters: member1 - the member1 member2 - the member2 Returns: true, if is assignable from getSuperclasses public static Class[] getSuperclasses(Class type) Returns all superclasses. Parameters: type - the type Returns: the superclasses isUserDefinedMethod public static boolean isUserDefinedMethod(Method method) Returns true if method is user defined and not defined in Object class. Parameters: method - the method Returns: true, if is user defined method isObjectMethod public static boolean isObjectMethod(Method method) Returns true if method defined in Object class. Parameters: method - the method Returns: true, if is object method isBeanProperty public static boolean isBeanProperty(Method method) Returns true if method is a bean property. Parameters: method - the method Returns: true, if is bean property isBeanPropertyGetter public static boolean isBeanPropertyGetter(Method method) Returns true if method is bean getter. Parameters: method - the method Returns: true, if is bean property getter getBeanPropertyGetterName public static String getBeanPropertyGetterName(Method method) Returns beans property getter name or null if method is not a real getter. Parameters: method - the method Returns: the bean property getter name isBeanPropertySetter public static boolean isBeanPropertySetter(Method method) Returns true if method is bean setter. Parameters: method - the method Returns: true, if is bean property setter getBeanPropertySetterName public static String getBeanPropertySetterName(Method method) Returns beans property setter name or null if method is not a real setter. Parameters: method - the method Returns: the bean property setter name getComponentType public static Class getComponentType(Type type) Returns component type of the given type. For ParameterizedType it returns the last type in array. Parameters: type - the type Returns: the component type getComponentType public static Class getComponentType(Type type, int index) Returns the component type of the given type. For example the following types all have the component-type MyClass: MyClass[] List<MyClass> Foo<? extends MyClass> Bar<? super MyClass> <T extends MyClass> T[] Parameters: type - is the type where to get the component type from. index - the index Returns: the component type of the given type or null if the given type does NOT have a single (component) type. getGenericSupertype public static Class getGenericSupertype(Class type, int index) Gets the generic supertype. Parameters: type - the type index - the index Returns: the generic supertype getGenericSupertype public static Class getGenericSupertype(Class type) Gets the generic supertype. Parameters: type - the type Returns: the generic supertype toClass public static Class toClass(Type type) Returns Class for the given type. Examples: type getSimpleType(type) String String List<String> List <T extends MyClass> T[] MyClass[] Parameters: type - is the type to convert. Returns: the closest class representing the given type. readAnnotationValue public static Object readAnnotationValue(Annotation annotation, String name) Reads annotation value. Returns null on error. Parameters: annotation - the annotation name - the name Returns: the object has public static <T> boolean has(T type, String methodName, boolean equalsIgnoreCase, Class<? extends Annotation> annotation) Checks the method for the given type of annotation, whether it contains it. Type Parameters: T - the generic type Parameters: type - the type methodName - the method name equalsIgnoreCase - the equals ignore case annotation - the annotation Returns: true, if successful getMethodsThatHas public static <T> List<String> getMethodsThatHas(T type, Class<? extends Annotation> annotation) Gets the methods that has. Type Parameters: T - the generic type Parameters: type - the type annotation - the annotation Returns: the methods that has executeMethod public static <T,V> V executeMethod(T type, String methodName, boolean equalsIgnoreCase, Object... args) Finds the method based on the name provided and executes the method by passing the arguments. Type Parameters: T - the generic type V - the value type Parameters: type - the object methodName - the method Name equalsIgnoreCase - the equals ignore case for method search args - the args Returns: the method value if it returns proper value like Integer, Void, Float, null if it is not executed success fully. executeMethod public static <T,V> V executeMethod(T type, String methodName, boolean equalsIgnoreCase, String... args) Finds the method based on the name provided and executes the method by passing the arguments. Type Parameters: T - the generic type V - the value type Parameters: type - the object methodName - the method Name equalsIgnoreCase - the equals ignore case for method search args - the args Returns: the method value if it returns proper value like Integer, Void, Float, null if it is not executed success fully. getDeclaredMethod public static <T> Method getDeclaredMethod(T type, String methodName, boolean equalsIgnoreCase) Gets the declared method. Type Parameters: T - the generic type Parameters: type - the type methodName - the method name equalsIgnoreCase - the equals ignore case Returns: the declared method getFieldValue public static <T,V> V getFieldValue(T type, String name, boolean equalsIgnoreCase) Gets the field value. Type Parameters: T - the generic type V - the value type Parameters: type - the object name - the name equalsIgnoreCase - the equals ignore case Returns: the field value setFieldValue public static <T,V> void setFieldValue(T type, String name, V value) Sets the field value. Type Parameters: T - the generic type V - the value type Parameters: type - the object name - the name value - the value setFieldValue public static <T> boolean setFieldValue(T type, String name, String value) Sets the field value by converting the string type of value to the required type of the field. Type Parameters: T - the generic type Parameters: type - the object name - the name value - the value Returns: true, if successful getDeclaredField public static <T> Field getDeclaredField(T type, String name, boolean equalsIgnoreCase) Gets the declared field. Type Parameters: T - the generic type Parameters: type - the object name - the name equalsIgnoreCase - the equals ignore case Returns: the declared field getFieldName public static <T> String getFieldName(T type, String name, boolean equalsIgnoreCase) Gets the declared field name as String. Type Parameters: T - the generic type Parameters: type - the object name - the name equalsIgnoreCase - the equals ignore case Returns: the declared field getFieldName public static <T> String getFieldName(Class<T> type, String name, boolean equalsIgnoreCase) Gets the declared field name as String. Type Parameters: T - the generic type Parameters: type - the object name - the name equalsIgnoreCase - the equals ignore case Returns: the declared field Skip navigation links Overview Package Class Use Tree Deprecated Index Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method Copyright © 2016 utils4j. All Rights Reserved.