com.opensymphony.xwork2.util
Class AnnotationUtils

java.lang.Object
  com.opensymphony.xwork2.util.AnnotationUtils

public class AnnotationUtils
extends Object

AnnotationUtils Various utility methods dealing with annotations

Version:

$Id: AnnotationUtils.java 1637 2007-10-15 14:59:41Z rainerh $

Author:

Rainer Hermanns, Zsolt Szasz, zsolt at lorecraft dot com, Dan Oxlade, dan d0t oxlade at gmail d0t c0m

Field Summary

private static Pattern	GETTER_PATTERN
private static Pattern	SETTER_PATTERN

Constructor Summary

AnnotationUtils()

Method Summary

static void	addAllFields(Class annotationClass, Class clazz, List<Field> allFields) Adds all fields with the specified Annotation of class clazz and its superclasses to allFields
static void	addAllInterfaces(Class clazz, List allInterfaces)
static void	addAllMethods(Class annotationClass, Class clazz, List<Method> allMethods) Adds all methods with the specified Annotation of class clazz and its superclasses to allFields
static String[]	find(Class clazz, String pckgname) Retrieves all classes within a packages.
static List<Method>	findAnnotatedMethods(Class clazz, Class<? extends Annotation> annotationClass) Deprecated. since 2.0.4 use getAnnotatedMethods
static void	findRecursively(Class clazz, Class<? extends Annotation> annotationClass, List<Method> methods) Deprecated. since 2.0.4 use getAnnotatedMethods
static Collection<Method>	getAnnotatedMethods(Class clazz, Class<? extends Annotation>... annotation) For the given Class get a collection of the the AnnotatedElements that match the given annotations or if no annotations are specified then return all of the annotated elements of the given Class.
static boolean	isAnnotatedBy(AnnotatedElement annotatedElement, Class<? extends Annotation>... annotation) Varargs version of AnnotatedElement.isAnnotationPresent()
static String	resolvePropertyName(Method method) Returns the property name for a method.

Methods inherited from class java.lang.Object

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

Field Detail

SETTER_PATTERN

private static final Pattern SETTER_PATTERN

GETTER_PATTERN

private static final Pattern GETTER_PATTERN

Constructor Detail

AnnotationUtils

public AnnotationUtils()

Method Detail

addAllFields

public static void addAllFields(Class annotationClass,
                                Class clazz,
                                List<Field> allFields)

Adds all fields with the specified Annotation of class clazz and its superclasses to allFields

Parameters:

annotationClass -

clazz -

allFields -

addAllMethods

public static void addAllMethods(Class annotationClass,
                                 Class clazz,
                                 List<Method> allMethods)

Adds all methods with the specified Annotation of class clazz and its superclasses to allFields

Parameters:

annotationClass -

clazz -

allMethods -

addAllInterfaces

public static void addAllInterfaces(Class clazz,
                                    List allInterfaces)

Parameters:

clazz -

allInterfaces -

getAnnotatedMethods

public static final Collection<Method> getAnnotatedMethods(Class clazz,
                                                           Class<? extends Annotation>... annotation)

For the given Class get a collection of the the AnnotatedElements that match the given annotations or if no annotations are specified then return all of the annotated elements of the given Class. Includes only the method level annotations.

Parameters:

clazz - The Class to inspect

annotation - the Annotations to find

Returns:

A Collection<AnnotatedElement> containing all of the method AnnotatedElements matching the specified Annotations

isAnnotatedBy

public static final boolean isAnnotatedBy(AnnotatedElement annotatedElement,
                                          Class<? extends Annotation>... annotation)

Varargs version of AnnotatedElement.isAnnotationPresent()

See Also:

AnnotatedElement

findAnnotatedMethods

@Deprecated
public static List<Method> findAnnotatedMethods(Class clazz,
                                                           Class<? extends Annotation> annotationClass)

Deprecated. since 2.0.4 use getAnnotatedMethods

findRecursively

@Deprecated
public static void findRecursively(Class clazz,
                                              Class<? extends Annotation> annotationClass,
                                              List<Method> methods)

Deprecated. since 2.0.4 use getAnnotatedMethods

resolvePropertyName

public static String resolvePropertyName(Method method)

Returns the property name for a method. This method is independant from property fields.

Parameters:

method - The method to get the property name for.

Returns:

the property name for given method; null if non could be resolved.

find

public static String[] find(Class clazz,
                            String pckgname)

Retrieves all classes within a packages. TODO: this currently does not work with jars.

Parameters:

pckgname -

Returns:

Array of full qualified class names from this package.