org.hippoecm.hst.util

Class AnnotationsScanner

java.lang.Object

org.hippoecm.hst.util.AnnotationsScanner

public class AnnotationsScanner
extends Object

Utility class for scanning (some) annotations for some methods or some class. This annotation scanning also scans all superclasses and super interfaces.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotationsScanner.MethodAnnotations object that contains all the annotations for some method

Constructor Summary

Constructors

Constructor and Description
AnnotationsScanner()

Method Summary

Modifier and Type	Method and Description
static Method	doGetAnnotatedMethod(Method method, Class<? extends Annotation> clazz) returns the annotated method with annotation clazz and null if the clazz annotation is not present
static Map<Method,Set<Annotation>>	getMethodAnnotations(Class<?> clazz) Returns the map of method mapped to all the annotation classes on such a method.
static List<AnnotationsScanner.MethodAnnotations>	getMethodAnnotationsList(Class<?> clazz) Returns the List of all AnnotationsScanner.MethodAnnotations for class clazz : Thus, all the methods that have an annotation (possibly on super classes/interfaces).

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationsScanner

public AnnotationsScanner()

Method Detail

getMethodAnnotations

public static Map<Method,Set<Annotation>> getMethodAnnotations(Class<?> clazz)

Returns the map of method mapped to all the annotation classes on such a method. Note that also annotations on the public methods of super classes and interfaces are present.

Parameters:

clazz -

Returns:

the map where the keys are all the Method instances that contain annotations, and the values are the set of annotation classes for the Method instance. Return empty map if no single method with an annotation is found

getMethodAnnotationsList

public static List<AnnotationsScanner.MethodAnnotations> getMethodAnnotationsList(Class<?> clazz)

Returns the List of all AnnotationsScanner.MethodAnnotations for class clazz : Thus, all the methods that have an annotation (possibly on super classes/interfaces).

Parameters:

clazz - the clazz to scan its methods

Returns:

the List of all AnnotationsScanner.MethodAnnotations for clazz. Empty list when no annotated methods found

doGetAnnotatedMethod

public static Method doGetAnnotatedMethod(Method method,
                                          Class<? extends Annotation> clazz)

returns the annotated method with annotation clazz and null if the clazz annotation is not present

Parameters:

method - the method to scan annotations for

clazz - the annotation to look for

Returns:

the Method that contains the annotation clazz and null if none found