net.obvj.agents.util

Class AnnotationUtils

java.lang.Object

net.obvj.agents.util.AnnotationUtils

public class AnnotationUtils
extends Object

Utility methods for working with annotations and package scanning.

Author:

oswaldo.bapvic.jr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotationUtils.MethodFilter Enumerates applicable method filters.

Method Summary

Modifier and Type	Method and Description
static Set<String>	findClassesWithAnnotation(Class<? extends Annotation> annotationClass, String basePackage) Scans the class path from a base package to find classes annotated with a given annotation.
static Method	getSinglePublicMethodWithAnnotation(Class<? extends Annotation> annotationClass, Class<?> sourceClass) Returns the public method of the given class that is annotated with the given annotation, provided that only a single method containing this annotation exists in the class.
static Method	getSinglePublicMethodWithAnnotation(Class<? extends Annotation> annotationClass, Class<?> sourceClass, AnnotationUtils.MethodFilter methodFilter) Returns the public method of the given class that is annotated with the given annotation, provided that only a single method containing this annotation exists in the class.

Methods inherited from class java.lang.Object

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

Method Detail

getSinglePublicMethodWithAnnotation

public static Method getSinglePublicMethodWithAnnotation(Class<? extends Annotation> annotationClass,
                                                         Class<?> sourceClass)

Returns the public method of the given class that is annotated with the given annotation, provided that only a single method containing this annotation exists in the class.

Note: This has the same effect as calling:

getSinglePublicMethodWithAnnotation(annotationClass, sourceClass, MethodFilter.DEFAULT);

Parameters:

annotationClass - the Annotation class that must be present on a method to be matched, not null

sourceClass - the Class to query, not null

Returns:

a Method which is annotated with the specified annotation

Throws:

NullPointerException - if either of the class parameters is null

InvalidClassException - if either no method or more than one method found

getSinglePublicMethodWithAnnotation

public static Method getSinglePublicMethodWithAnnotation(Class<? extends Annotation> annotationClass,
                                                         Class<?> sourceClass,
                                                         AnnotationUtils.MethodFilter methodFilter)

Returns the public method of the given class that is annotated with the given annotation, provided that only a single method containing this annotation exists in the class.

Parameters:

annotationClass - the Annotation class that must be present on a method to be matched, not null

sourceClass - the Class to query, not null

methodFilter - the AnnotationUtils.MethodFilter to apply; null is allowed and it defaults to AnnotationUtils.MethodFilter.DEFAULT

Returns:

a Method which is annotated with the specified annotation

Throws:

NullPointerException - if either of the class parameters is null

InvalidClassException - if either no method or more than one method found, or if the method does not match the rules of the specified AnnotationUtils.MethodFilter

findClassesWithAnnotation

public static Set<String> findClassesWithAnnotation(Class<? extends Annotation> annotationClass,
                                                    String basePackage)

Scans the class path from a base package to find classes annotated with a given annotation.

Parameters:

annotationClass - the annotation to be filter

basePackage - the package to search for annotated classes

Returns:

a set of auto-detected class names; or an empty set