Module org.junit.jupiter.api

Package org.junit.jupiter.api

Interface MethodDescriptor

@API(status=STABLE,
     since="5.7")
public interface MethodDescriptor

MethodDescriptor encapsulates functionality for a given Method.

Since:

5.4

See Also:

MethodOrdererContext

Method Summary

Modifier and Type	Method	Description
<A extends Annotation> Optional<A>	findAnnotation(Class<A> annotationType)	Find the first annotation of annotationType that is either present or meta-present on the Method for this descriptor.
<A extends Annotation> List<A>	findRepeatableAnnotations(Class<A> annotationType)	Find all repeatable annotations of annotationType that are either present or meta-present on the Method for this descriptor.
String	getDisplayName()	Get the display name for this descriptor's method.
Method	getMethod()	Get the method for this descriptor.
boolean	isAnnotated(Class<? extends Annotation> annotationType)	Determine if an annotation of annotationType is either present or meta-present on the Method for this descriptor.

Method Detail

getMethod

Method getMethod()

Get the method for this descriptor.

Returns:

the method; never null

getDisplayName

@API(status=EXPERIMENTAL,
     since="5.7")
String getDisplayName()

Get the display name for this descriptor's method.

Returns:

the display name for this descriptor's method; never null or blank

Since:

5.7

isAnnotated

boolean isAnnotated(Class<? extends Annotation> annotationType)

Determine if an annotation of annotationType is either present or meta-present on the Method for this descriptor.

Parameters:

annotationType - the annotation type to search for; never null

Returns:

true if the annotation is present or meta-present

See Also:

findAnnotation(Class), findRepeatableAnnotations(Class)

findAnnotation

<A extends Annotation> Optional<A> findAnnotation(Class<A> annotationType)

Find the first annotation of annotationType that is either present or meta-present on the Method for this descriptor.

Type Parameters:

A - the annotation type

Parameters:

annotationType - the annotation type to search for; never null

Returns:

an Optional containing the annotation; never null but potentially empty

See Also:

isAnnotated(Class), findRepeatableAnnotations(Class)

findRepeatableAnnotations

<A extends Annotation> List<A> findRepeatableAnnotations(Class<A> annotationType)

Find all repeatable annotations of annotationType that are either present or meta-present on the Method for this descriptor.

Type Parameters:

A - the annotation type

Parameters:

annotationType - the repeatable annotation type to search for; never null

Returns:

the list of all such annotations found; neither null nor mutable, but potentially empty

See Also:

isAnnotated(Class), findAnnotation(Class), Repeatable