org.junit.jupiter.api.extension

Interface TestTemplateInvocationContext

@API(status=STABLE,
     since="5.0")
public interface TestTemplateInvocationContext

TestTemplateInvocationContext represents the context of a single invocation of a test template.

Each context is provided by a TestTemplateInvocationContextProvider.

Since:

5.0

See Also:

TestTemplate, TestTemplateInvocationContextProvider

Method Summary

Modifier and Type	Method and Description
default List<Extension>	getAdditionalExtensions() Get the additional extensions for this invocation.
default String	getDisplayName(int invocationIndex) Get the display name for this invocation.

Method Detail

getDisplayName

default String getDisplayName(int invocationIndex)

Get the display name for this invocation.

The supplied invocationIndex is incremented by the framework with each test invocation. Thus, in the case of multiple active providers, only the first active provider receives indices starting with 1.

The default implementation returns the supplied invocationIndex wrapped in brackets — for example, [1], [42], etc.

Parameters:

invocationIndex - the index of this invocation (1-based).

Returns:

the display name for this invocation; never null or blank

getAdditionalExtensions

default List<Extension> getAdditionalExtensions()

Get the additional extensions for this invocation.

The extensions provided by this method will only be used for this invocation of the test template. Thus, it does not make sense to return an extension that acts solely on the container level (e.g. BeforeAllCallback).

The default implementation returns an empty list.

Returns:

the additional extensions for this invocation; never null but potentially empty