org.junit.jupiter.api.extension

Interface ParameterContext

@API(value=Experimental)
public interface ParameterContext

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 and Description
default java.lang.reflect.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.
java.lang.reflect.Parameter	getParameter() Get the Parameter for this context.
java.util.Optional<java.lang.Object>	getTarget() Get the target on which the Executable that declares the Parameter for this context will be invoked, if available.

Method Detail

getParameter

java.lang.reflect.Parameter getParameter()

Get the Parameter for this context.

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 java.lang.reflect.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

java.util.Optional<java.lang.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.