Module org.junit.jupiter.api

Package org.junit.jupiter.api.extension

Interface ParameterContext

All Superinterfaces:

AnnotatedElementContext

@API(status=STABLE,
     since="5.0")
public interface ParameterContext
extends AnnotatedElementContext

ParameterContext encapsulates the context in which an Executable will be invoked for a given Parameter.

A ParameterContext is used to support parameter resolution via a ParameterResolver.

Since:

5.0

See Also:

• ParameterResolver
• Parameter
• Executable
• Method
• Constructor

Method Summary

Modifier and Type	Method	Description
default <A extends Annotation> Optional<A>	findAnnotation(Class<A> annotationType)	Find the first annotation of annotationType that is either present or meta-present on the AnnotatedElement for this context.
default <A extends Annotation> List<A>	findRepeatableAnnotations(Class<A> annotationType)	Find all repeatable annotations of annotationType that are either present or meta-present on the AnnotatedElement for this context.
default AnnotatedElement	getAnnotatedElement()	Get the AnnotatedElement for this context.
default Executable	getDeclaringExecutable()	Get the Executable (i.e., the Method or Constructor) that declares the Parameter for this context.
int	getIndex()	Get the index of the Parameter for this context within the parameter list of the Executable that declares the parameter.
Parameter	getParameter()	Get the Parameter for this context.
Optional<Object>	getTarget()	Get the target on which the Executable that declares the Parameter for this context will be invoked, if available.
default boolean	isAnnotated(Class<? extends Annotation> annotationType)	Determine if an annotation of annotationType is either present or meta-present on the AnnotatedElement for this context.

Method Details

getParameter

Parameter getParameter()

Get the Parameter for this context.

WARNING

When searching for annotations on the parameter in this context, favor isAnnotated(Class), findAnnotation(Class), and findRepeatableAnnotations(Class) over methods in the Parameter API due to a bug in javac on JDK versions prior to JDK 9.

Returns:

the parameter; never null

See Also:

• getIndex()

getIndex

int getIndex()

Get the index of the Parameter for this context within the parameter list of the Executable that declares the parameter.

Returns:

the index of the parameter

See Also:

• getParameter()
• Executable.getParameters()

getDeclaringExecutable

default Executable getDeclaringExecutable()

Get the Executable (i.e., the Method or Constructor) that declares the Parameter for this context.

Returns:

the declaring Executable; never null

See Also:

• Parameter.getDeclaringExecutable()

getTarget

Optional<Object> getTarget()

Get the target on which the Executable that declares the Parameter for this context will be invoked, if available.

Returns:

an Optional containing the target on which the Executable will be invoked; never null but will be empty if the Executable is a constructor or a static method.

getAnnotatedElement

@API(status=EXPERIMENTAL,
     since="5.10")
default AnnotatedElement getAnnotatedElement()

Get the AnnotatedElement for this context.

WARNING

When searching for annotations on the annotated element in this context, favor AnnotatedElementContext.isAnnotated(Class), AnnotatedElementContext.findAnnotation(Class), and AnnotatedElementContext.findRepeatableAnnotations(Class) over methods in the AnnotatedElement API due to a bug in javac on JDK versions prior to JDK 9.

Specified by:

getAnnotatedElement in interface AnnotatedElementContext

Returns:

the annotated element; never null

Since:

5.10

isAnnotated

@API(status=STABLE,
     since="5.10")
default boolean isAnnotated(Class<? extends Annotation> annotationType)

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

WARNING

Favor the use of this method over directly invoking AnnotatedElement.isAnnotationPresent(Class) due to a bug in javac on JDK versions prior to JDK 9.

Specified by:

isAnnotated in interface AnnotatedElementContext

Parameters:

annotationType - the annotation type to search for; never null

Returns:

true if the annotation is present or meta-present

Since:

5.1.1

See Also:

• AnnotatedElementContext.findAnnotation(Class)
• AnnotatedElementContext.findRepeatableAnnotations(Class)

findAnnotation

@API(status=STABLE,
     since="5.10")
default <A extends Annotation> Optional<A> findAnnotation(Class<A> annotationType)

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

WARNING

Favor the use of this method over directly invoking annotation lookup methods in the AnnotatedElement API due to a bug in javac on JDK versions prior to JDK 9.

Specified by:

findAnnotation in interface AnnotatedElementContext

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

Since:

5.1.1

See Also:

• AnnotatedElementContext.isAnnotated(Class)
• AnnotatedElementContext.findRepeatableAnnotations(Class)

findRepeatableAnnotations

@API(status=STABLE,
     since="5.10")
default <A extends Annotation> List<A> findRepeatableAnnotations(Class<A> annotationType)

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

WARNING

Favor the use of this method over directly invoking annotation lookup methods in the AnnotatedElement API due to a bug in javac on JDK versions prior to JDK 9.

Specified by:

findRepeatableAnnotations in interface AnnotatedElementContext

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

Since:

5.1.1

See Also:

• AnnotatedElementContext.isAnnotated(Class)
• AnnotatedElementContext.findAnnotation(Class)
• Repeatable