org.jboss.weld.util.reflection

Class Reflections

java.lang.Object

org.jboss.weld.util.reflection.Reflections

public class Reflections
extends java.lang.Object

Utility class for static reflection-type operations

Author:

Pete Muir, Ales Justin, Marko Luksa

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.annotation.Annotation[]	EMPTY_ANNOTATIONS
static java.lang.Class<?>[]	EMPTY_CLASSES
static java.lang.reflect.Type[]	EMPTY_TYPES

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.Class<?>,java.lang.reflect.Type>	buildTypeMap(java.util.Set<java.lang.reflect.Type> types)
static <T> T	cast(java.lang.Object obj)
static void	checkDeclaringClassLoadable(java.lang.Class<?> c) Triggers loading of declaring class (if any) of the given class recursively.
static boolean	containsWildcards(java.lang.reflect.Type[] types)
static java.lang.reflect.Method	findDeclaredMethodByName(java.lang.Class<?> clazz, java.lang.String methodName) Searches for a declared method with a given name.
static java.lang.reflect.Type[]	getActualTypeArguments(java.lang.Class<?> clazz) Gets the actual type arguments of a class
static java.lang.reflect.Type[]	getActualTypeArguments(java.lang.reflect.Type type) Gets the actual type arguments of a Type
static int	getNesting(java.lang.Class<?> clazz)
static java.lang.Object	getNonPrivateFinalMethodOrType(java.lang.Class<?> type)
static java.lang.String	getPropertyName(java.lang.reflect.Method method) Gets the property name from a getter method.
static <T> java.lang.Class<T>	getRawType(java.lang.reflect.Type type)
static <T> T	invokeAndUnwrap(java.lang.Object instance, java.lang.reflect.Method method, java.lang.Object... parameters) Invokes the method on a given instance passing in given parameters.
static boolean	isAbstract(java.lang.Class<?> clazz)
static boolean	isAbstract(java.lang.reflect.Method method) Checks if a method is abstract
static boolean	isArrayType(java.lang.Class<?> rawType) Checks if raw type is array type
static boolean	isBindings(java.lang.annotation.Annotation binding) Deprecated.
static boolean	isCacheable(java.lang.annotation.Annotation[] annotations)
static boolean	isCacheable(java.util.Collection<java.lang.annotation.Annotation> annotations)
static boolean	isClassLoadable(java.lang.String className, ResourceLoader resourceLoader)
static boolean	isFinal(java.lang.Class<?> clazz) Checks if class is final
static boolean	isFinal(java.lang.reflect.Member member) Checks if member is final
static boolean	isNonStaticInnerClass(java.lang.Class<?> javaClass)
static boolean	isPackagePrivate(int mod)
static boolean	isParameterizedType(java.lang.Class<?> type) Checks if type is parameterized type
static boolean	isParameterizedTypeWithWildcard(java.lang.Class<?> type)
static boolean	isPrimitive(java.lang.reflect.Type type)
static boolean	isPrivate(java.lang.reflect.Member member) Checks if member is private
static boolean	isSerializable(java.lang.Class<?> clazz)
static boolean	isStatic(java.lang.Class<?> type) Checks if type is static
static boolean	isStatic(java.lang.reflect.Member member) Checks if member is static
static boolean	isTransient(java.lang.reflect.Member member)
static boolean	isTypeOrAnyMethodFinal(java.lang.Class<?> type) Checks if type or member is final
static boolean	isUnboundedTypeVariable(java.lang.reflect.Type type)
static boolean	isUnboundedWildcard(java.lang.reflect.Type type)
static <T> java.lang.Class<T>	loadClass(java.lang.String className, ResourceLoader resourceLoader) Tries to load a class using the specified ResourceLoader.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_TYPES

public static final java.lang.reflect.Type[] EMPTY_TYPES

EMPTY_ANNOTATIONS

public static final java.lang.annotation.Annotation[] EMPTY_ANNOTATIONS

EMPTY_CLASSES

public static final java.lang.Class<?>[] EMPTY_CLASSES

Method Detail

buildTypeMap

public static java.util.Map<java.lang.Class<?>,java.lang.reflect.Type> buildTypeMap(java.util.Set<java.lang.reflect.Type> types)

isCacheable

public static boolean isCacheable(java.util.Collection<java.lang.annotation.Annotation> annotations)

isCacheable

public static boolean isCacheable(java.lang.annotation.Annotation[] annotations)

cast

public static <T> T cast(java.lang.Object obj)

getPropertyName

public static java.lang.String getPropertyName(java.lang.reflect.Method method)

Gets the property name from a getter method.

We extend JavaBean conventions, allowing the getter method to have parameters

Parameters:

method - The getter method

Returns:

The name of the property. Returns null if method wasn't JavaBean getter-styled

isFinal

public static boolean isFinal(java.lang.Class<?> clazz)

Checks if class is final

Parameters:

clazz - The class to check

Returns:

True if final, false otherwise

getNesting

public static int getNesting(java.lang.Class<?> clazz)

isFinal

public static boolean isFinal(java.lang.reflect.Member member)

Checks if member is final

Parameters:

member - The member to check

Returns:

True if final, false otherwise

isPrivate

public static boolean isPrivate(java.lang.reflect.Member member)

Checks if member is private

Parameters:

member - The member to check

Returns:

True if final, false otherwise

isTypeOrAnyMethodFinal

public static boolean isTypeOrAnyMethodFinal(java.lang.Class<?> type)

Checks if type or member is final

Parameters:

type - Type or member

Returns:

True if final, false otherwise

getNonPrivateFinalMethodOrType

public static java.lang.Object getNonPrivateFinalMethodOrType(java.lang.Class<?> type)

isPackagePrivate

public static boolean isPackagePrivate(int mod)

isStatic

public static boolean isStatic(java.lang.Class<?> type)

Checks if type is static

Parameters:

type - Type to check

Returns:

True if static, false otherwise

isStatic

public static boolean isStatic(java.lang.reflect.Member member)

Checks if member is static

Parameters:

member - Member to check

Returns:

True if static, false otherwise

isTransient

public static boolean isTransient(java.lang.reflect.Member member)

isAbstract

public static boolean isAbstract(java.lang.reflect.Method method)

Checks if a method is abstract

Parameters:

method - the method

Returns:

true if abstract

isAbstract

public static boolean isAbstract(java.lang.Class<?> clazz)

getActualTypeArguments

public static java.lang.reflect.Type[] getActualTypeArguments(java.lang.Class<?> clazz)

Gets the actual type arguments of a class

Parameters:

clazz - The class to examine

Returns:

The type arguments

getActualTypeArguments

public static java.lang.reflect.Type[] getActualTypeArguments(java.lang.reflect.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(java.lang.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(java.lang.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(java.lang.Class<?> type)

containsWildcards

public static boolean containsWildcards(java.lang.reflect.Type[] types)

isBindings

@Deprecated
public static boolean isBindings(java.lang.annotation.Annotation binding)

Deprecated.

Checks the bindingType to make sure the annotation was declared properly as a binding type (annotated with @BindingType) and that it has a runtime retention policy.

Parameters:

binding - The binding type to check

Returns:

true only if the annotation is really a binding type

isSerializable

public static boolean isSerializable(java.lang.Class<?> clazz)

isPrimitive

public static boolean isPrimitive(java.lang.reflect.Type type)

getRawType

public static <T> java.lang.Class<T> getRawType(java.lang.reflect.Type type)

isClassLoadable

public static boolean isClassLoadable(java.lang.String className,
                                      ResourceLoader resourceLoader)

loadClass

public static <T> java.lang.Class<T> loadClass(java.lang.String className,
                                               ResourceLoader resourceLoader)

Tries to load a class using the specified ResourceLoader. Returns null if the class is not found.

Parameters:

className -

resourceLoader -

Returns:

the loaded class or null if the given class cannot be loaded

isUnboundedWildcard

public static boolean isUnboundedWildcard(java.lang.reflect.Type type)

isUnboundedTypeVariable

public static boolean isUnboundedTypeVariable(java.lang.reflect.Type type)

isNonStaticInnerClass

public static boolean isNonStaticInnerClass(java.lang.Class<?> javaClass)

See Also:

https://issues.jboss.org/browse/WELD-1081

invokeAndUnwrap

public static <T> T invokeAndUnwrap(java.lang.Object instance,
                                    java.lang.reflect.Method method,
                                    java.lang.Object... parameters)
                             throws java.lang.Throwable

Invokes the method on a given instance passing in given parameters. If the invocation yields InvocationTargetException, the exception is unwrapped. It is a responsibility of the caller to make sure that the method is accessible to the caller.

Throws:

java.lang.Throwable

checkDeclaringClassLoadable

public static void checkDeclaringClassLoadable(java.lang.Class<?> c)

Triggers loading of declaring class (if any) of the given class recursively. If the class cannot be loaded, the underlying LinkageError is propagated.

Parameters:

class - the given class

Throws:

java.lang.LinkageError - or its subclass if a declaring class cannot be loaded

findDeclaredMethodByName

public static java.lang.reflect.Method findDeclaredMethodByName(java.lang.Class<?> clazz,
                                                                java.lang.String methodName)

Searches for a declared method with a given name. If the class declares multiple methods with the given name, there is no guarantee as of which methods is returned. Null is returned if the class does not declare a method with the given name.

Parameters:

clazz - the given class

methodName - the given method name

Returns:

method method with the given name declared by the given class or null if no such method exists