org.testifyproject.trait

Interface AnnotationTrait<T extends AnnotatedElement>

Type Parameters:

T - the annotation element type

All Known Subinterfaces:

FieldAnnotationTrait, FieldDescriptor, FieldTrait, MethodDescriptor, MethodTrait, ParameterDescriptor, SutDescriptor, TestDescriptor

public interface AnnotationTrait<T extends AnnotatedElement>

A contract that specifies annotated element traits.

Author:

saden

Method Summary

Modifier and Type	Method and Description
T	getAnnotatedElement() Get the annotated element .
default <A extends Annotation> Optional<A>	getAnnotation(Class<A> annotationType) Get the given annotation on the annotated element.
default <A extends Annotation> List<A>	getAnnotations(Class<A> annotationType) Get all the annotations of the given type.
default Annotation[]	getMetaAnnotations(Collection<Class<? extends Annotation>>... metaAnnotationTypes) Get the meta annotations declared on the annotated element itself or annotations on the annotated element.
default boolean	hasAnyAnnotations(Class<? extends Annotation>... annotationTypes) Determine if the annotated element has any of the given annotations.
default boolean	hasAnyAnnotations(Collection<Class<? extends Annotation>> annotationTypes) Determine if the annotated element has any of the given annotations.

Method Detail

getAnnotatedElement

T getAnnotatedElement()

Get the annotated element .

Returns:

an instance of the annotated element.

getAnnotation

default <A extends Annotation> Optional<A> getAnnotation(Class<A> annotationType)

Get the given annotation on the annotated element.

Type Parameters:

A - annotation type

Parameters:

annotationType - the annotation type

Returns:

optional with annotation, empty optional otherwise

getAnnotations

default <A extends Annotation> List<A> getAnnotations(Class<A> annotationType)

Get all the annotations of the given type.

Type Parameters:

A - annotation type

Parameters:

annotationType - the annotation type

Returns:

optional with annotation, empty optional otherwise

getMetaAnnotations

default Annotation[] getMetaAnnotations(Collection<Class<? extends Annotation>>... metaAnnotationTypes)

Get the meta annotations declared on the annotated element itself or annotations on the annotated element.

Parameters:

metaAnnotationTypes - an array of meta annotations

Returns:

an array of meta annotations

hasAnyAnnotations

default boolean hasAnyAnnotations(Class<? extends Annotation>... annotationTypes)

Determine if the annotated element has any of the given annotations.

Parameters:

annotationTypes - the annotations we are looking for

Returns:

true if at least one annotation found, false otherwise

hasAnyAnnotations

default boolean hasAnyAnnotations(Collection<Class<? extends Annotation>> annotationTypes)

Determine if the annotated element has any of the given annotations.

Parameters:

annotationTypes - the annotations we are looking for

Returns:

true if at least one annotation found, false otherwise