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

public Interface TestTemplateInvocationContextProvider

extends Extension
Annotations
@API
status:STABLE
since:5.0
Static Imports
org.apiguardian.api.API.Status.STABLE
TestTemplateInvocationContextProvider defines the API for Extensions that wish to provide one or multiple contexts for the invocation of a @TestTemplate method.

This extension point makes it possible to execute a test template in different contexts — for example, with different parameters, by preparing the test class instance differently, or multiple times without modifying the context.

This interface defines two methods: supportsTestTemplate and provideTestTemplateInvocationContexts. The former is called by the framework to determine whether this extension wants to act on a test template that is about to be executed. If so, the latter is called and must return a Stream of TestTemplateInvocationContext instances. Otherwise, this provider is ignored for the execution of the current test template.

A provider that has returned true from its supportsTestTemplate method is called active. When multiple providers are active for a test template method, the Streams returned by their provideTestTemplateInvocationContexts methods will be chained, and the test template method will be invoked using the contexts of all active providers.

Constructor Requirements

Consult the documentation in Extension for details on constructor requirements.

Since
5.0
See Also
org.junit.jupiter.api.TestTemplate, TestTemplateInvocationContext

Method Summary

Modifier and TypeMethod and Description
public Stream<TestTemplateInvocationContext>

Returns:

a Stream of TestTemplateInvocationContext instances for the invocation of the test template method; never null
provideTestTemplateInvocationContexts(ExtensionContext
the extension context for the test template method about to be invoked; never null
context)

Provide invocation contexts for the test template method represented by the supplied context.

public boolean

Returns:

true if this provider can provide invocation contexts
supportsTestTemplate(ExtensionContext
the extension context for the test template method about to be invoked; never null
context)

Determine if this provider supports providing invocation contexts for the test template method represented by the supplied context.

Method Detail

provideTestTemplateInvocationContextsback to summary
public Stream<TestTemplateInvocationContext> provideTestTemplateInvocationContexts(ExtensionContext context)

Provide invocation contexts for the test template method represented by the supplied context.

This method is only called by the framework if supportsTestTemplate previously returned true for the same ExtensionContext; this method is allowed to return an empty Stream but not null.

The returned Stream will be properly closed by calling Stream#close(), making it safe to use a resource such as Files.lines().

Parameters
context:ExtensionContext

the extension context for the test template method about to be invoked; never null

Returns:Stream<TestTemplateInvocationContext>

a Stream of TestTemplateInvocationContext instances for the invocation of the test template method; never null

See Also
supportsTestTemplate, ExtensionContext
supportsTestTemplateback to summary
public boolean supportsTestTemplate(ExtensionContext context)

Determine if this provider supports providing invocation contexts for the test template method represented by the supplied context.

Parameters
context:ExtensionContext

the extension context for the test template method about to be invoked; never null

Returns:boolean

true if this provider can provide invocation contexts

See Also
provideTestTemplateInvocationContexts, ExtensionContext