org.junit.platform.commons.util

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 and Description
static List<Method>	findAnnotatedMethods(Class<?> clazz, Class<? extends Annotation> annotationType, ReflectionUtils.HierarchyTraversalMode traversalMode)
static <A extends Annotation> Optional<A>	findAnnotation(AnnotatedElement element, Class<A> annotationType)
static <A extends Annotation> Optional<A>	findAnnotation(Optional<? extends AnnotatedElement> element, Class<A> annotationType) Find the first annotation of annotationType that is either present or meta-present on the supplied optional element.
static List<Field>	findPublicAnnotatedFields(Class<?> clazz, Class<?> fieldType, Class<? extends Annotation> annotationType)
static <A extends Annotation> List<A>	findRepeatableAnnotations(AnnotatedElement element, Class<A> annotationType)
static <T> Optional<T>	getDefaultValue(Annotation annotation, String attributeName, Class<T> attributeType) Get the default value of the named attribute from the supplied Annotation.
static boolean	isAnnotated(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(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 Detail

getDefaultValue

public static <T> Optional<T> getDefaultValue(Annotation annotation,
                                              String attributeName,
                                              Class<T> attributeType)

Get the default value of the named attribute from the supplied Annotation.

Parameters:

annotation - the annotation from which to retrieve the default value; never null

attributeName - the name of the attribute for which the default value should be retrieved; never null or empty

attributeType - the required type of the attribute; never null

Returns:

an Optional containing the default value; potentially empty if the attribute does not have a default value.

isAnnotated

public static boolean isAnnotated(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)

isAnnotated

public static boolean isAnnotated(AnnotatedElement element,
                                  Class<? extends Annotation> annotationType)

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

See Also:

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

findAnnotation

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

Find the first annotation of annotationType that is either present or meta-present on the supplied optional element.

See Also:

findAnnotation(AnnotatedElement, Class)

findAnnotation

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

See Also:

AnnotationSupport.findAnnotation(AnnotatedElement, Class)

findRepeatableAnnotations

public static <A extends Annotation> List<A> findRepeatableAnnotations(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)

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)