Top Description Methods
org.junit.jupiter.api.extension

public Interface ClassTemplateInvocationContext

Annotations
@API
status:EXPERIMENTAL
since:6.0
Static Imports
java.util.Collections.emptyList, org.apiguardian.api.API.Status.EXPERIMENTAL

ClassTemplateInvocationContext represents the context of a single invocation of a @ClassTemplate.

Each context is provided by a ClassTemplateInvocationContextProvider.

Since
5.13
See Also
ClassTemplate, ClassTemplateInvocationContextProvider

Method Summary

Modifier and TypeMethod and Description
public default List<Extension>

Returns:

the additional extensions for this invocation; never null or containing null elements, but potentially empty
getAdditionalExtensions
()

Get the additional extensions for this invocation.

public default String

Returns:

the display name for this invocation; never null or blank
getDisplayName
(int
the index of this invocation (1-based).
invocationIndex
)

Get the display name for this invocation.

public default void
prepareInvocation(ExtensionContext
The invocation-level extension context.
context
)

Prepare the imminent invocation of the class template.

Method Detail

getAdditionalExtensionsback to summary
public 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 class 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:List<Extension>

the additional extensions for this invocation; never null or containing null elements, but potentially empty

getDisplayNameback to summary
public default String getDisplayName(int invocationIndex)

Get the display name for this invocation.

The supplied invocationIndex is incremented by the framework with each container 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:int

the index of this invocation (1-based).

Returns:String

the display name for this invocation; never null or blank

prepareInvocationback to summary
public default void prepareInvocation(ExtensionContext context)

Prepare the imminent invocation of the class template.

This may be used, for example, to store entries in the Store to benefit from its cleanup support or for retrieval by other extensions.

Parameters
context:ExtensionContext

The invocation-level extension context.