org.kuali.common.util

Class ReflectionUtils

java.lang.Object

org.springframework.util.ReflectionUtils

org.kuali.common.util.ReflectionUtils

public class ReflectionUtils
extends org.springframework.util.ReflectionUtils

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.util.ReflectionUtils

org.springframework.util.ReflectionUtils.FieldCallback, org.springframework.util.ReflectionUtils.FieldFilter, org.springframework.util.ReflectionUtils.MethodCallback, org.springframework.util.ReflectionUtils.MethodFilter

Field Summary

Fields inherited from class org.springframework.util.ReflectionUtils

COPYABLE_FIELDS, NON_BRIDGED_METHODS, USER_DECLARED_METHODS

Constructor Summary

Constructors

Constructor and Description
ReflectionUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	copyProperty(Object bean, String name, Object value)
static Map<String,Object>	describe(Object bean)
static com.google.common.base.Optional<Object>	extractFieldValue(Field field, Object instance) Unconditionally attempt to get the value of this field on this bean.
static com.google.common.base.Optional<Object>	get(Field field, Object instance) Deprecated. Use extractFieldValue instead
static Set<Field>	getAllFields(Class<?> type) Recursively examine the type hierarchy and extract every field encountered anywhere in the hierarchy into an immutable set
static List<Field>	getAllFieldsList(Class<?> type) Recursively examine the type hierarchy and extract every field encountered anywhere in the hierarchy into an immutable list
static List<Type>	getAllGenericInterfaces(Class<?> type) Return a list containing every interface implemented by type, includes interfaces implemented by super classes.
static Map<Class<?>,ParameterizedType>	getAllParameterizedInterfaces(Class<?> type) Return a map containing every parameterized interface implemented by type, includes interfaces implemented by super classes
static <T extends Annotation> com.google.common.base.Optional<T>	getAnnotation(Class<?> type, Class<T> annotationClass) Deprecated. Use Annotations.get() instead
static <T extends Annotation> com.google.common.base.Optional<T>	getAnnotation(Field field, Class<T> annotationClass) Deprecated. Use Annotations.get() instead
static Class<?>	getClass(String className)
static List<Class<?>>	getDeclarationHierarchy(Class<?> type)
static String	getDeclarationPath(Class<?> type)
static Set<Field>	getFields(Class<?> type) Get fields declared directly on this type as an immutable set.
static Set<Field>	getFields(Class<?> type, boolean includeInheritedFields) Get fields for a given type with the option to include all inherited fields
static Map<String,Field>	getFields(Class<?> type, Set<String> fieldNames) Return the field corresponding
static Map<String,Field>	getNameMap(List<Field> fields) Convert the list of fields into a Map keyed by field name.
static Map<String,Field>	getNameMap(Set<Field> fields) Deprecated. use getNameMap(List) instead
static <T> Class<? extends T>	getTypedClass(String className)
static List<Class<?>>	getTypeHierarchy(Class<?> type) Returns the path from java.lang.Object, to type.
static Map<String,Field>	getUniqueFieldNames(Class<?> type) Get a list of all fields contained anywhere in the type hierarchy keyed by field name.
protected static boolean	hasMatchingActualTypeArguments(ParameterizedType type, Class<?>... expectedTypeArguments)
static boolean	hasMatchingParameterizedArgTypes(Field field, Class<?>... expectedTypeArguments) Return true if this field is a generic whose argument types match expectedTypeArguments
static boolean	hasUniqueFieldNames(Class<?> type) Return true if every single field in the recursive type hiearchy has a unique name, false otherwise
static boolean	hasUniqueFieldNames(List<Field> fields)
static boolean	hasUniqueFieldNames(Set<Field> fields) Return true if the fields in this set can be uniquely represented by field name alone
static Object	invoke(org.springframework.util.MethodInvoker invoker)
static Object	invokeMethod(Class<?> targetClass, String targetMethod, Object... arguments)
static Object	invokeMethod(Object targetObject, String targetMethod, Object... arguments)
static boolean	isCharSequence(Class<?> type) Return true if this field is a CharSequence
static boolean	isCharSequence(Field field) Return true if this field is a CharSequence
static boolean	isCollection(Field field) Return true if this field is a java.util.Collection
static boolean	isFinal(Class<?> type) Return true if this class is declared as final
static boolean	isFinal(Field field) Return true if this field is declared as final
static boolean	isImmutableGuavaCollection(Class<?> type) Return true if this class is an immutable Guava collection
static boolean	isImmutableGuavaMap(Class<?> type) Return true if this class is an immutable Guava map
static boolean	isMap(Field field) Return true if this field is a java.util.Map
static boolean	isOptional(Field field) Return true iff this field is a Guava com.google.common.base.Optional
static boolean	isOptionalString(Field field) Return true iff this field is a Guava com.google.common.base.Optional<String>
static boolean	isString(Field field) Return true if this field is a java.lang.String
static boolean	isStringCollection(Field field) Return true if this field is a java.util.Collection<String>
static boolean	isStringKeyedMap(Field field) Return true if this field extends from java.util.Map and uses String for its keys
static boolean	isSuperType(Class<?> superType, Class<?> type) Return true if type descends from superType OR is the same as superType.
static <T> T	newInstance(Class<T> instanceClass)
static <T> T	newInstance(String className)
static void	set(Object instance, Field field, Object value) Unconditionally attempt to set a value on this field of this instance.
static void	validateIsSuperType(Class<?> superType, Class<?> type) Throw an exception unless child is the same as parent OR descends from parent.

Methods inherited from class org.springframework.util.ReflectionUtils

declaresException, doWithFields, doWithFields, doWithMethods, doWithMethods, findField, findField, findMethod, findMethod, getAllDeclaredMethods, getField, getUniqueDeclaredMethods, handleInvocationTargetException, handleReflectionException, invokeJdbcMethod, invokeJdbcMethod, invokeMethod, invokeMethod, isCglibRenamedMethod, isEqualsMethod, isHashCodeMethod, isObjectMethod, isPublicStaticFinal, isToStringMethod, makeAccessible, makeAccessible, makeAccessible, rethrowException, rethrowRuntimeException, setField, shallowCopyFieldState

Methods inherited from class java.lang.Object

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

Constructor Detail

ReflectionUtils

public ReflectionUtils()

Method Detail

getTypeHierarchy

public static List<Class<?>> getTypeHierarchy(Class<?> type)

Returns the path from java.lang.Object, to type. The last element in the list is type.

getAllParameterizedInterfaces

public static Map<Class<?>,ParameterizedType> getAllParameterizedInterfaces(Class<?> type)

Return a map containing every parameterized interface implemented by type, includes interfaces implemented by super classes

getAllGenericInterfaces

public static List<Type> getAllGenericInterfaces(Class<?> type)

Return a list containing every interface implemented by type, includes interfaces implemented by super classes. Type objects returned accurately reflect the actual type parameters used in the source code.

isFinal

public static boolean isFinal(Class<?> type)

Return true if this class is declared as final

isFinal

public static boolean isFinal(Field field)

Return true if this field is declared as final

isImmutableGuavaCollection

public static boolean isImmutableGuavaCollection(Class<?> type)

Return true if this class is an immutable Guava collection

isImmutableGuavaMap

public static boolean isImmutableGuavaMap(Class<?> type)

Return true if this class is an immutable Guava map

isCollection

public static boolean isCollection(Field field)

Return true if this field is a java.util.Collection

isStringCollection

public static boolean isStringCollection(Field field)

Return true if this field is a java.util.Collection<String>

isMap

public static boolean isMap(Field field)

Return true if this field is a java.util.Map

isStringKeyedMap

public static boolean isStringKeyedMap(Field field)

Return true if this field extends from java.util.Map and uses String for its keys

 Map<String,String>  returns true
 Map<String,Object>  returns true
 Map<String,Integer> returns true
 Map<Integer,String> returns false
 

isString

public static boolean isString(Field field)

Return true if this field is a java.lang.String

isCharSequence

public static boolean isCharSequence(Field field)

Return true if this field is a CharSequence

isCharSequence

public static boolean isCharSequence(Class<?> type)

Return true if this field is a CharSequence

isOptional

public static boolean isOptional(Field field)

Return true iff this field is a Guava com.google.common.base.Optional

isOptionalString

public static boolean isOptionalString(Field field)

Return true iff this field is a Guava com.google.common.base.Optional<String>

hasMatchingParameterizedArgTypes

public static boolean hasMatchingParameterizedArgTypes(Field field,
                                       Class<?>... expectedTypeArguments)

Return true if this field is a generic whose argument types match expectedTypeArguments

For example to match a field declared as Collection<String>

 hasMatchingParameterizedArgTypes(myField, String.class)
 

hasMatchingActualTypeArguments

protected static boolean hasMatchingActualTypeArguments(ParameterizedType type,
                                     Class<?>... expectedTypeArguments)

validateIsSuperType

public static void validateIsSuperType(Class<?> superType,
                       Class<?> type)

Throw an exception unless child is the same as parent OR descends from parent. If child is a primitive type, throw an exception unless both child and parent are the exact same primitive type.

Throws:

IllegalArgumentException - if equalsOrDescendsFrom(child,parent) returns false

See Also:

equalsOrDescendsFrom

isSuperType

public static boolean isSuperType(Class<?> superType,
                  Class<?> type)

Return true if type descends from superType OR is the same as superType. If type is a primitive type, return true only if both type and superType are the exact same primitive type.

getAnnotation

@Deprecated
public static <T extends Annotation> com.google.common.base.Optional<T> getAnnotation(Class<?> type,
                                                                                 Class<T> annotationClass)

Deprecated. Use Annotations.get() instead

getAnnotation

@Deprecated
public static <T extends Annotation> com.google.common.base.Optional<T> getAnnotation(Field field,
                                                                                 Class<T> annotationClass)

Deprecated. Use Annotations.get() instead

getDeclarationHierarchy

public static List<Class<?>> getDeclarationHierarchy(Class<?> type)

getDeclarationPath

public static String getDeclarationPath(Class<?> type)

extractFieldValue

public static com.google.common.base.Optional<Object> extractFieldValue(Field field,
                                                        Object instance)

Unconditionally attempt to get the value of this field on this bean. If the field is not accessible make it accessible, get the value, then revert the field back to being inaccessible.

get

@Deprecated
public static com.google.common.base.Optional<Object> get(Field field,
                                                     Object instance)

Deprecated. Use extractFieldValue instead

Unconditionally attempt to get the value of this field on this bean. If the field is not accessible make it accessible, get the value, then revert the field back to being inaccessible.

set

public static void set(Object instance,
       Field field,
       Object value)

Unconditionally attempt to set a value on this field of this instance. If the field is not accessible, make it accessible, set the value, then revert the field to being inaccessible.

getFields

public static Set<Field> getFields(Class<?> type)

Get fields declared directly on this type as an immutable set.

getFields

public static Set<Field> getFields(Class<?> type,
                   boolean includeInheritedFields)

Get fields for a given type with the option to include all inherited fields

NOTE: field.getName() is not necessarily unique for the elements in the set if includeInheritedFields is true

getNameMap

@Deprecated
public static Map<String,Field> getNameMap(Set<Field> fields)

Deprecated. use getNameMap(List) instead

Convert the set of fields into a Map keyed by field name. If there are fields that contain duplicate names in the set, which one makes it into the map is undefined

getNameMap

public static Map<String,Field> getNameMap(List<Field> fields)

Convert the list of fields into a Map keyed by field name. If there are duplicate field names in the list, "last one in wins"

getUniqueFieldNames

public static Map<String,Field> getUniqueFieldNames(Class<?> type)

Get a list of all fields contained anywhere in the type hierarchy keyed by field name.

Throws:

IllegalArgumentException - if type contains duplicate field names

getFields

public static Map<String,Field> getFields(Class<?> type,
                          Set<String> fieldNames)

Return the field corresponding

Parameters:

type -

fieldNames -

Returns:

getAllFields

public static Set<Field> getAllFields(Class<?> type)

Recursively examine the type hierarchy and extract every field encountered anywhere in the hierarchy into an immutable set

NOTE: field.getName() is not necessarily unique for the elements in the set

getAllFieldsList

public static List<Field> getAllFieldsList(Class<?> type)

Recursively examine the type hierarchy and extract every field encountered anywhere in the hierarchy into an immutable list

NOTE: field.getName() is not necessarily unique for the elements in the list

hasUniqueFieldNames

public static boolean hasUniqueFieldNames(Class<?> type)

Return true if every single field in the recursive type hiearchy has a unique name, false otherwise

hasUniqueFieldNames

public static boolean hasUniqueFieldNames(Set<Field> fields)

Return true if the fields in this set can be uniquely represented by field name alone

hasUniqueFieldNames

public static boolean hasUniqueFieldNames(List<Field> fields)

describe

public static Map<String,Object> describe(Object bean)

copyProperty

public static void copyProperty(Object bean,
                String name,
                Object value)

invokeMethod

public static Object invokeMethod(Class<?> targetClass,
                  String targetMethod,
                  Object... arguments)

invokeMethod

public static Object invokeMethod(Object targetObject,
                  String targetMethod,
                  Object... arguments)

invoke

public static Object invoke(org.springframework.util.MethodInvoker invoker)

getClass

public static Class<?> getClass(String className)

getTypedClass

public static <T> Class<? extends T> getTypedClass(String className)

newInstance

public static <T> T newInstance(String className)

newInstance

public static <T> T newInstance(Class<T> instanceClass)