org.reflections

Class ReflectionUtils

java.lang.Object

org.reflections.ReflectionUtils

Direct Known Subclasses:

Reflections

public abstract class ReflectionUtils
extends Object

convenient java reflection helper methods

1. some helper methods to get type by name: forName(String, ClassLoader...) and forNames(Iterable, ClassLoader...)

2. some helper methods to get all types/methods/fields matching some predicates, generally:

 Set<?> result = getAllXXX(type/s, withYYY) 

where get methods are:

• getAllSuperTypes(Class, com.google.common.base.Predicate)
• getAllFields(Class, com.google.common.base.Predicate)
• getAllMethods(Class, com.google.common.base.Predicate)
• getAll(Iterable, com.google.common.base.Predicate)

and predicates included here all starts with "with", such as

• withAnnotation(java.lang.annotation.Annotation)
• withModifier(int)
• withName(String)
• withParameters(Class[])
• withParameterAnnotations(Class[])
• withParametersAssignableTo(Class[])
• withPrefix(String)
• withReturnType(Class)
• withType(Class)
• withTypeAssignableTo(java.lang.Class<T>)

for example, getting all getters would be:

      Set<Method> getters = getAllMethods(someClasses, 
              Predicates.and(
                      withModifier(Modifier.PUBLIC), 
                      withPrefix("get"), 
                      withParametersCount(0)));
     

Constructor Summary

Constructors

Constructor and Description
ReflectionUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	areAnnotationMembersMatching(Annotation annotation1, Annotation annotation2) checks for annotation member values matching, based on equality of members
static Class<?>	forName(String typeName, ClassLoader... classLoaders) tries to resolve a java type name to a Class
static <T> List<Class<? extends T>>	forNames(Iterable<String> classes, ClassLoader... classLoaders) try to resolve all given string representation of types to a list of java types
static <T extends AnnotatedElement> Set<T>	getAll(Iterable<? extends T> elements, com.google.common.base.Predicate<? super T> predicate) filter all given elements with predicate
static Set<Field>	getAllFields(Class<?> type, com.google.common.base.Predicate<? super Field> predicate) get all fields of given type, including, filtered by predicate
static Set<Field>	getAllFields(Iterable<? extends Class<?>> types, com.google.common.base.Predicate<? super Field> predicate)
static Set<Method>	getAllMethods(Class<?> type, com.google.common.base.Predicate<? super Method> predicate) get all methods of given type, including, filtered by predicate
static Set<Method>	getAllMethods(Iterable<? extends Class<?>> types, com.google.common.base.Predicate<? super Method> predicate) get all methods of given types, filtered by predicate
static Set<Class<?>>	getAllSuperTypes(Class<?> type, com.google.common.base.Predicate<? super Class<?>> predicate) get all super types of given type, including, filtered by optional predicates
static Set<Class<?>>	getAllSuperTypes(Iterable<? extends Class<?>> types, com.google.common.base.Predicate<? super Class<?>> predicate)
static <T extends AnnotatedElement> Set<T>	getMatchingAnnotations(Set<T> annotatedElements, Annotation annotation) returns a subset of given annotatedWith, where annotation member values matches the given annotation
static List<String>	getPrimitiveDescriptors()
static List<String>	getPrimitiveNames()
static List<Class>	getPrimitiveTypes()
static List<String>	names(Iterable<Class<?>> types)
static <T extends AnnotatedElement> com.google.common.base.Predicate<T>	withAnnotation(Annotation annotation) where element is annotated with given annotation, including member matching
static <T extends AnnotatedElement> com.google.common.base.Predicate<T>	withAnnotation(Class<? extends Annotation> annotation) where element is annotated with given annotation
static <T extends AnnotatedElement> com.google.common.base.Predicate<T>	withAnnotations(Annotation... annotations) where element is annotated with given annotations, including member matching
static <T extends AnnotatedElement> com.google.common.base.Predicate<T>	withAnnotations(Class<? extends Annotation>... annotations) where element is annotated with given annotations
static <T extends Member> com.google.common.base.Predicate<T>	withModifier(int mod) when member modifier matches given mod
static <T extends Member> com.google.common.base.Predicate<T>	withName(String name) where member name equals given name
static com.google.common.base.Predicate<Method>	withParameterAnnotations(Annotation... annotations)
static com.google.common.base.Predicate<Method>	withParameterAnnotations(Class<? extends Annotation>... annotationClasses)
static com.google.common.base.Predicate<Method>	withParameters(Class<?>... types) when method parameter types equals given types
static com.google.common.base.Predicate<Method>	withParametersAssignableTo(Class... types) when method parameter types assignable to given types
static com.google.common.base.Predicate<Method>	withParametersCount(int count) when method parameter types count equal given count
static <T extends Member> com.google.common.base.Predicate<T>	withPrefix(String prefix) where member name startsWith given prefix
static <T> com.google.common.base.Predicate<Method>	withReturnType(Class<T> type) when method return type equal given type
static <T> com.google.common.base.Predicate<Method>	withReturnTypeAssignableTo(Class<T> type) when method return type assignable from given type
static <T> com.google.common.base.Predicate<Field>	withType(Class<T> type) when field type equal given type
static <T> com.google.common.base.Predicate<Field>	withTypeAssignableTo(Class<T> type) when field type assignable to given type

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

getAllSuperTypes

public static Set<Class<?>> getAllSuperTypes(Class<?> type,
                             com.google.common.base.Predicate<? super Class<?>> predicate)

get all super types of given type, including, filtered by optional predicates

for example:

 Set<Class<?>> annotatedSuperTypes =
      getAllSuperTypes(type, withAnnotation(annotation));
 

getAllSuperTypes

public static Set<Class<?>> getAllSuperTypes(Iterable<? extends Class<?>> types,
                             com.google.common.base.Predicate<? super Class<?>> predicate)

getAllFields

public static Set<Field> getAllFields(Class<?> type,
                      com.google.common.base.Predicate<? super Field> predicate)

get all fields of given type, including, filtered by predicate

for example:

 Set<Field<?>> injectables =
      getAllFields(type,
          Predicates.or(withAnnotation(Inject.class), withAnnotation(Autowired.class)));
 

getAllFields

public static Set<Field> getAllFields(Iterable<? extends Class<?>> types,
                      com.google.common.base.Predicate<? super Field> predicate)

getAllMethods

public static Set<Method> getAllMethods(Class<?> type,
                        com.google.common.base.Predicate<? super Method> predicate)

get all methods of given type, including, filtered by predicate

for example:

 Set<Method> getters =
      getAllMethods(someClasses,
          Predicates.and(
              withModifier(Modifier.PUBLIC),
              withPrefix("get"),
              withParametersCount(0)));
 

getAllMethods

public static Set<Method> getAllMethods(Iterable<? extends Class<?>> types,
                        com.google.common.base.Predicate<? super Method> predicate)

get all methods of given types, filtered by predicate

getAll

public static <T extends AnnotatedElement> Set<T> getAll(Iterable<? extends T> elements,
                                         com.google.common.base.Predicate<? super T> predicate)

filter all given elements with predicate

withName

public static <T extends Member> com.google.common.base.Predicate<T> withName(String name)

where member name equals given name

withPrefix

public static <T extends Member> com.google.common.base.Predicate<T> withPrefix(String prefix)

where member name startsWith given prefix

withAnnotation

public static <T extends AnnotatedElement> com.google.common.base.Predicate<T> withAnnotation(Class<? extends Annotation> annotation)

where element is annotated with given annotation

withAnnotations

public static <T extends AnnotatedElement> com.google.common.base.Predicate<T> withAnnotations(Class<? extends Annotation>... annotations)

where element is annotated with given annotations

withAnnotation

public static <T extends AnnotatedElement> com.google.common.base.Predicate<T> withAnnotation(Annotation annotation)

where element is annotated with given annotation, including member matching

withAnnotations

public static <T extends AnnotatedElement> com.google.common.base.Predicate<T> withAnnotations(Annotation... annotations)

where element is annotated with given annotations, including member matching

withParameters

public static com.google.common.base.Predicate<Method> withParameters(Class<?>... types)

when method parameter types equals given types

withParametersAssignableTo

public static com.google.common.base.Predicate<Method> withParametersAssignableTo(Class... types)

when method parameter types assignable to given types

withParametersCount

public static com.google.common.base.Predicate<Method> withParametersCount(int count)

when method parameter types count equal given count

withParameterAnnotations

public static com.google.common.base.Predicate<Method> withParameterAnnotations(Annotation... annotations)

withParameterAnnotations

public static com.google.common.base.Predicate<Method> withParameterAnnotations(Class<? extends Annotation>... annotationClasses)

withType

public static <T> com.google.common.base.Predicate<Field> withType(Class<T> type)

when field type equal given type

withTypeAssignableTo

public static <T> com.google.common.base.Predicate<Field> withTypeAssignableTo(Class<T> type)

when field type assignable to given type

withReturnType

public static <T> com.google.common.base.Predicate<Method> withReturnType(Class<T> type)

when method return type equal given type

withReturnTypeAssignableTo

public static <T> com.google.common.base.Predicate<Method> withReturnTypeAssignableTo(Class<T> type)

when method return type assignable from given type

withModifier

public static <T extends Member> com.google.common.base.Predicate<T> withModifier(int mod)

when member modifier matches given mod

for example:

 withModifier(Modifier.PUBLIC)
 withModifier(Modifier.PROTECTED | Modifier.PUBLIC)
 

areAnnotationMembersMatching

public static boolean areAnnotationMembersMatching(Annotation annotation1,
                                   Annotation annotation2)

checks for annotation member values matching, based on equality of members

getMatchingAnnotations

public static <T extends AnnotatedElement> Set<T> getMatchingAnnotations(Set<T> annotatedElements,
                                                         Annotation annotation)

returns a subset of given annotatedWith, where annotation member values matches the given annotation

forName

public static Class<?> forName(String typeName,
               ClassLoader... classLoaders)

tries to resolve a java type name to a Class

if optional ClassLoaders are not specified, then both ClasspathHelper.contextClassLoader() and ClasspathHelper.staticClassLoader() are used

forNames

public static <T> List<Class<? extends T>> forNames(Iterable<String> classes,
                                    ClassLoader... classLoaders)

try to resolve all given string representation of types to a list of java types

names

public static List<String> names(Iterable<Class<?>> types)

getPrimitiveNames

public static List<String> getPrimitiveNames()

getPrimitiveTypes

public static List<Class> getPrimitiveTypes()

getPrimitiveDescriptors

public static List<String> getPrimitiveDescriptors()