org.apache.deltaspike.core.util

Class ReflectionUtils

java.lang.Object

org.apache.deltaspike.core.util.ReflectionUtils

@Typed
public abstract class ReflectionUtils
extends Object

Utilities for common reflection based actions. Some are basic Java Reflection based, others are CDI based.

Method Summary

Methods

Modifier and Type	Method and Description
static Type[]	getActualTypeArguments(Class<?> clazz) Gets the actual type arguments of a class
static Type[]	getActualTypeArguments(Type type) Gets the actual type arguments of a Type
static Set<Field>	getAllDeclaredFields(Class<?> clazz) Get all the declared fields on the class hierarchy.
static Set<Method>	getAllDeclaredMethods(Class<?> clazz) Get all the declared methods on the class hierarchy.
static <T> Class<T>	getRawType(Type type) Extract the raw type, given a type.
static <T> T	invokeMethod(Object instance, Method method, Class<T> expectedReturnType, boolean setAccessible, Object... args) Invoke the method on the instance, with any arguments specified, casting the result of invoking the method to the expected return type.
static boolean	isAbstract(Method method) Checks if a method is abstract
static boolean	isArrayType(Class<?> rawType) Checks if raw type is array type
static boolean	isFinal(Class<?> clazz) Checks if class is final
static boolean	isFinal(Member member) Checks if member is final
static boolean	isPackagePrivate(int mod)
static boolean	isParameterizedType(Class<?> type) Checks if type is parameterized type
static boolean	isParameterizedTypeWithWildcard(Class<?> type)
static boolean	isPrimitive(Type type)
static boolean	isPrivate(Member member) Checks if member is private
static boolean	isSerializable(Class<?> clazz) Check if a class is serializable.
static boolean	isStatic(Class<?> type) Checks if type is static
static boolean	isStatic(Member member) Checks if member is static
static boolean	isTransient(Member member)
static Field	tryToFindDeclaredField(Class<?> clazz, String name) Search the class hierarchy for a field with the given name.

Methods inherited from class java.lang.Object

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

Method Detail

getAllDeclaredFields

public static Set<Field> getAllDeclaredFields(Class<?> clazz)

Get all the declared fields on the class hierarchy. This will return overridden fields.

Parameters:

clazz - The class to search

Returns:

the set of all declared fields or an empty set if there are none

tryToFindDeclaredField

public static Field tryToFindDeclaredField(Class<?> clazz,
                           String name)

Search the class hierarchy for a field with the given name. Will return the nearest match, starting with the class specified and searching up the hierarchy.

Parameters:

clazz - The class to search

name - The name of the field to search for

Returns:

The field found, or null if no field is found

getAllDeclaredMethods

public static Set<Method> getAllDeclaredMethods(Class<?> clazz)

Get all the declared methods on the class hierarchy. This will return overridden methods.

Parameters:

clazz - The class to search

Returns:

the set of all declared methods or an empty set if there are none

invokeMethod

public static <T> T invokeMethod(Object instance,
                 Method method,
                 Class<T> expectedReturnType,
                 boolean setAccessible,
                 Object... args)
                      throws IllegalAccessException,
                             IllegalArgumentException

Invoke the method on the instance, with any arguments specified, casting the result of invoking the method to the expected return type.

This method wraps Method.invoke(Object, Object...), converting the checked exceptions that Method.invoke(Object, Object...) specifies to runtime exceptions.

If instructed, this method attempts to set the accessible flag of the method in a PrivilegedAction before invoking the method.

Parameters:

setAccessible - flag indicating whether method should first be set as accessible

method - the method to invoke

instance - the instance to invoke the method

args - the arguments to the method

Returns:

the result of invoking the method, or null if the method's return type is void

Throws:

RuntimeException - if this Method object enforces Java language access control and the underlying method is inaccessible or if the underlying method throws an exception or if the initialization provoked by this method fails.

IllegalArgumentException - if the method is an instance method and the specified instance argument is not an instance of the class or interface declaring the underlying method (or of a subclass or implementor thereof); if the number of actual and formal parameters differ; if an unwrapping conversion for primitive arguments fails; or if, after possible unwrapping, a parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion.

NullPointerException - if the specified instance is null and the method is an instance method.

ClassCastException - if the result of invoking the method cannot be cast to the expectedReturnType

ExceptionInInitializerError - if the initialization provoked by this method fails.

IllegalAccessException

See Also:

Method.invoke(Object, Object...)

getRawType

public static <T> Class<T> getRawType(Type type)

Extract the raw type, given a type.

Type Parameters:

T - the type

Parameters:

type - the type to extract the raw type from

Returns:

the raw type, or null if the raw type cannot be determined.

isSerializable

public static boolean isSerializable(Class<?> clazz)

Check if a class is serializable.

Parameters:

clazz - The class to check

Returns:

true if the class implements serializable or is a primitive (needed for type Void

isFinal

public static boolean isFinal(Class<?> clazz)

Checks if class is final

Parameters:

clazz - The class to check

Returns:

True if final, false otherwise

isFinal

public static boolean isFinal(Member member)

Checks if member is final

Parameters:

member - The member to check

Returns:

True if final, false otherwise

isPrivate

public static boolean isPrivate(Member member)

Checks if member is private

Parameters:

member - The member to check

Returns:

True if final, false otherwise

isPackagePrivate

public static boolean isPackagePrivate(int mod)

isStatic

public static boolean isStatic(Class<?> type)

Checks if type is static

Parameters:

type - Type to check

Returns:

True if static, false otherwise

isStatic

public static boolean isStatic(Member member)

Checks if member is static

Parameters:

member - Member to check

Returns:

True if static, false otherwise

isTransient

public static boolean isTransient(Member member)

isAbstract

public static boolean isAbstract(Method method)

Checks if a method is abstract

getActualTypeArguments

public static Type[] getActualTypeArguments(Class<?> clazz)

Gets the actual type arguments of a class

Parameters:

clazz - The class to examine

Returns:

The type arguments

getActualTypeArguments

public static Type[] getActualTypeArguments(Type type)

Gets the actual type arguments of a Type

Parameters:

type - The type to examine

Returns:

The type arguments

isArrayType

public static boolean isArrayType(Class<?> rawType)

Checks if raw type is array type

Parameters:

rawType - The raw type to check

Returns:

True if array, false otherwise

isParameterizedType

public static boolean isParameterizedType(Class<?> type)

Checks if type is parameterized type

Parameters:

type - The type to check

Returns:

True if parameterized, false otherwise

isParameterizedTypeWithWildcard

public static boolean isParameterizedTypeWithWildcard(Class<?> type)

isPrimitive

public static boolean isPrimitive(Type type)