org.testng.internal.annotations

Interface IAnnotationFinder

All Known Implementing Classes:

JDK15AnnotationFinder

public interface IAnnotationFinder

This interface defines how annotations are found on classes, methods and constructors. It will be implemented by both JDK 1.4 and JDK 5 annotation finders.

Method Summary

Modifier and Type	Method and Description
<A extends IAnnotation> A	findAnnotation(Class<?> cls, Class<A> annotationClass)
<A extends IAnnotation> A	findAnnotation(Class<?> clazz, Method m, Class<A> annotationClass)
<A extends IAnnotation> A	findAnnotation(Constructor<?> cons, Class<A> annotationClass)
<A extends IAnnotation> A	findAnnotation(ConstructorOrMethod com, Class<A> annotationClass)
<A extends IAnnotation> A	findAnnotation(ITestNGMethod m, Class<A> annotationClass)
<A extends IAnnotation> A	findAnnotation(Method m, Class<A> annotationClass)
<A extends IAnnotation> List<A>	findInheritedAnnotations(Class<?> cls, Class<A> annotationClass)
String[]	findOptionalValues(Constructor<?> ctor)
String[]	findOptionalValues(Method method)
boolean	hasTestInstance(Method method, int i)

Method Detail

findAnnotation

<A extends IAnnotation> A findAnnotation(Class<?> cls,
                                         Class<A> annotationClass)

Type Parameters:

A - The expected IAnnotation type

Parameters:

cls - - The corresponding class.

annotationClass - - The class on which annotation is to be looked for.

Returns:

The annotation on the class or null if none found.

findAnnotation

<A extends IAnnotation> A findAnnotation(Method m,
                                         Class<A> annotationClass)

Type Parameters:

A - The expected IAnnotation type

Parameters:

m - - The corresponding Method

annotationClass - - The class on which annotation is to be looked for.

Returns:

The annotation on the method. If not found, return the annotation on the declaring class. If not found, return null.

findAnnotation

<A extends IAnnotation> A findAnnotation(ITestNGMethod m,
                                         Class<A> annotationClass)

findAnnotation

<A extends IAnnotation> A findAnnotation(ConstructorOrMethod com,
                                         Class<A> annotationClass)

findAnnotation

<A extends IAnnotation> A findAnnotation(Class<?> clazz,
                                         Method m,
                                         Class<A> annotationClass)

findAnnotation

<A extends IAnnotation> A findAnnotation(Constructor<?> cons,
                                         Class<A> annotationClass)

Type Parameters:

A - The expected IAnnotation type

Parameters:

cons - - The corresponding Constructor

annotationClass - - The class on which annotation is to be looked for.

Returns:

The annotation on the method. If not found, return the annotation on the declaring class. If not found, return null.

findInheritedAnnotations

<A extends IAnnotation> List<A> findInheritedAnnotations(Class<?> cls,
                                                         Class<A> annotationClass)

Type Parameters:

A - - The expected IAnnotation type

Parameters:

cls - - The corresponding class.

annotationClass - - The class on which annotation is to be looked for.

Returns:

The annotations on the inherited interfaces. If not found, return the annotations on the declaring interface. If not found, return an empty list.

hasTestInstance

boolean hasTestInstance(Method method,
                        int i)

Parameters:

method - The Method

i - The parameter index

Returns:

true if the ith parameter of the given method has the annotation @TestInstance.

findOptionalValues

String[] findOptionalValues(Method method)

Parameters:

method - The Method

Returns:

the @Optional values of this method's parameters (null if the parameter isn't optional)

findOptionalValues

String[] findOptionalValues(Constructor<?> ctor)

Parameters:

ctor - The Constructor

Returns:

the @Optional values of this method's parameters (null if the parameter isn't optional)