Class AnnotationUtils

java.lang.Object

org.junit.platform.commons.util.AnnotationUtils

@API(status=INTERNAL,
     since="1.0")
public final class AnnotationUtils
extends Object

Collection of utilities for working with annotations.

DISCLAIMER

These utilities are intended solely for usage within the JUnit framework itself. Any usage by external parties is not supported. Use at your own risk!

Some utilities are published via the maintained AnnotationSupport class.

Since:

1.0

See Also:

• Annotation
• AnnotatedElement
• AnnotationSupport

Method Summary

Modifier and Type	Method	Description
static List<Field>	findAnnotatedFields(Class<?> clazz, Class<? extends Annotation> annotationType, Predicate<Field> predicate)
static List<Field>	findAnnotatedFields(Class<?> clazz, Class<? extends Annotation> annotationType, Predicate<Field> predicate, ReflectionUtils.HierarchyTraversalMode traversalMode)	Find all fields of the supplied class or interface that are annotated or meta-annotated with the specified annotationType and match the specified predicate.
static List<Method>	findAnnotatedMethods(Class<?> clazz, Class<? extends Annotation> annotationType, ReflectionUtils.HierarchyTraversalMode traversalMode)
static <A extends Annotation> Optional<A>	findAnnotation(@Nullable Class<?> clazz, Class<A> annotationType, boolean searchEnclosingClasses)	Find the first annotation of the specified type that is either directly present, meta-present, or indirectly present on the supplied class, optionally searching recursively through the enclosing class hierarchy if not found on the supplied class.
static <A extends Annotation> Optional<A>	findAnnotation(@Nullable AnnotatedElement element, Class<A> annotationType)
static <A extends Annotation> Optional<A>	findAnnotation(Parameter parameter, int index, Class<A> annotationType)
static <A extends Annotation> Optional<A>	findAnnotation(@Nullable Optional<? extends AnnotatedElement> element, Class<A> annotationType)
static List<Field>	findPublicAnnotatedFields(Class<?> clazz, Class<?> fieldType, Class<? extends Annotation> annotationType)
static <A extends Annotation> List<A>	findRepeatableAnnotations(@Nullable AnnotatedElement element, Class<A> annotationType)
static <A extends Annotation> List<A>	findRepeatableAnnotations(Parameter parameter, int index, Class<A> annotationType)
static <A extends Annotation> List<A>	findRepeatableAnnotations(@Nullable Optional<? extends AnnotatedElement> element, Class<A> annotationType)
static boolean	isAnnotated(@Nullable AnnotatedElement element, Class<? extends Annotation> annotationType)	Determine if an annotation of annotationType is either present or meta-present on the supplied element.
static boolean	isAnnotated(Parameter parameter, int index, Class<? extends Annotation> annotationType)
static boolean	isAnnotated(@Nullable Optional<? extends AnnotatedElement> element, Class<? extends Annotation> annotationType)	Determine if an annotation of annotationType is either present or meta-present on the supplied optional element.

Methods inherited from class java.lang.Object

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

Method Details

isAnnotated

@Contract("null, _ -> false")
public static boolean isAnnotated(@Nullable Optional<? extends AnnotatedElement> element,
 Class<? extends Annotation> annotationType)

Determine if an annotation of annotationType is either present or meta-present on the supplied optional element.

See Also:

• findAnnotation(Optional, Class)
• AnnotationSupport.isAnnotated(Optional, Class)

isAnnotated

public static boolean isAnnotated(Parameter parameter,
 int index,
 Class<? extends Annotation> annotationType)

Since:

1.8

See Also:

• findAnnotation(Parameter, int, Class)

isAnnotated

@Contract("null, _ -> false")
public static boolean isAnnotated(@Nullable AnnotatedElement element,
 Class<? extends Annotation> annotationType)

Determine if an annotation of annotationType is either present or meta-present on the supplied element.

Parameters:

element - the element on which to search for the annotation; may be null

annotationType - the annotation type to search for; never null

Returns:

true if the annotation is present or meta-present

See Also:

• findAnnotation(AnnotatedElement, Class)
• AnnotationSupport.isAnnotated(AnnotatedElement, Class)

findAnnotation

public static <A extends Annotation> Optional<A> findAnnotation(@Nullable Optional<? extends AnnotatedElement> element,
 Class<A> annotationType)

See Also:

• AnnotationSupport.findAnnotation(Optional, Class)

findAnnotation

public static <A extends Annotation> Optional<A> findAnnotation(Parameter parameter,
 int index,
 Class<A> annotationType)

Since:

1.8

See Also:

• findAnnotation(AnnotatedElement, Class)

findAnnotation

public static <A extends Annotation> Optional<A> findAnnotation(@Nullable AnnotatedElement element,
 Class<A> annotationType)

See Also:

• AnnotationSupport.findAnnotation(AnnotatedElement, Class)

findAnnotation

public static <A extends Annotation> Optional<A> findAnnotation(@Nullable Class<?> clazz,
 Class<A> annotationType,
 boolean searchEnclosingClasses)

Find the first annotation of the specified type that is either directly present, meta-present, or indirectly present on the supplied class, optionally searching recursively through the enclosing class hierarchy if not found on the supplied class.

The enclosing class hierarchy will only be searched above an inner class (i.e., a non-static member class).

Type Parameters:

A - the annotation type

Parameters:

clazz - the class on which to search for the annotation; may be null

annotationType - the annotation type to search for; never null

searchEnclosingClasses - whether the enclosing class hierarchy should be searched

Returns:

an Optional containing the annotation; never null but potentially empty

Since:

1.8

See Also:

• findAnnotation(AnnotatedElement, Class)

findRepeatableAnnotations

public static <A extends Annotation> List<A> findRepeatableAnnotations(@Nullable Optional<? extends AnnotatedElement> element,
 Class<A> annotationType)

Since:

1.5

See Also:

• AnnotationSupport.findRepeatableAnnotations(Optional, Class)

findRepeatableAnnotations

public static <A extends Annotation> List<A> findRepeatableAnnotations(Parameter parameter,
 int index,
 Class<A> annotationType)

Since:

1.8

See Also:

• findRepeatableAnnotations(AnnotatedElement, Class)

findRepeatableAnnotations

public static <A extends Annotation> List<A> findRepeatableAnnotations(@Nullable AnnotatedElement element,
 Class<A> annotationType)

See Also:

• AnnotationSupport.findRepeatableAnnotations(AnnotatedElement, Class)

findPublicAnnotatedFields

public static List<Field> findPublicAnnotatedFields(Class<?> clazz,
 Class<?> fieldType,
 Class<? extends Annotation> annotationType)

See Also:

• AnnotationSupport.findPublicAnnotatedFields(Class, Class, Class)

findAnnotatedFields

public static List<Field> findAnnotatedFields(Class<?> clazz,
 Class<? extends Annotation> annotationType,
 Predicate<Field> predicate)

See Also:

• AnnotationSupport.findAnnotatedFields(Class, Class, Predicate)
• findAnnotatedFields(Class, Class, Predicate, HierarchyTraversalMode)

findAnnotatedFields

public static List<Field> findAnnotatedFields(Class<?> clazz,
 Class<? extends Annotation> annotationType,
 Predicate<Field> predicate,
 ReflectionUtils.HierarchyTraversalMode traversalMode)

Find all fields of the supplied class or interface that are annotated or meta-annotated with the specified annotationType and match the specified predicate.

Parameters:

clazz - the class or interface in which to find the fields; never null

annotationType - the annotation type to search for; never null

predicate - the field filter; never null

traversalMode - the hierarchy traversal mode; never null

Returns:

the list of all such fields found; neither null nor mutable

findAnnotatedMethods

public static List<Method> findAnnotatedMethods(Class<?> clazz,
 Class<? extends Annotation> annotationType,
 ReflectionUtils.HierarchyTraversalMode traversalMode)

See Also:

• AnnotationSupport.findAnnotatedMethods(Class, Class, org.junit.platform.commons.support.HierarchyTraversalMode)