Package org.junit.jupiter.api.extension

JUnit Jupiter API for writing extensions.

Interface Summary

Interface	Description
AfterAllCallback	AfterAllCallback defines the API for Extensions that wish to provide additional behavior to test containers once after all tests in the container have been executed.
AfterClassTemplateInvocationCallback	AfterClassTemplateInvocationCallback defines the API for Extensions that wish to provide additional behavior once before each invocation of a @ClassTemplate.
AfterEachCallback	AfterEachCallback defines the API for Extensions that wish to provide additional behavior to tests after an individual test and any user-defined teardown methods (e.g., @AfterEach methods) for that test have been executed.
AfterTestExecutionCallback	AfterTestExecutionCallback defines the API for Extensions that wish to provide additional behavior to tests immediately after an individual test has been executed but before any user-defined teardown methods (e.g., @AfterEach methods) have been executed for that test.
AnnotatedElementContext	AnnotatedElementContext encapsulates the context in which an AnnotatedElement is declared.
BeforeAllCallback	BeforeAllCallback defines the API for Extensions that wish to provide additional behavior to test containers once before all tests in the container have been executed.
BeforeClassTemplateInvocationCallback	BeforeClassTemplateInvocationCallback defines the API for Extensions that wish to provide additional behavior once before each invocation of a @ClassTemplate.
BeforeEachCallback	BeforeEachCallback defines the API for Extensions that wish to provide additional behavior to tests before an individual test and any user-defined setup methods (e.g., @BeforeEach methods) for that test have been executed.
BeforeTestExecutionCallback	BeforeTestExecutionCallback defines the API for Extensions that wish to provide additional behavior to tests immediately before an individual test is executed but after any user-defined setup methods (e.g., @BeforeEach methods) have been executed for that test.
ClassTemplateInvocationContext	ClassTemplateInvocationContext represents the context of a single invocation of a @ClassTemplate.
ClassTemplateInvocationContextProvider	ClassTemplateInvocationContextProvider defines the API for Extensions that wish to provide one or multiple contexts for the invocation of a @ClassTemplate.
DynamicTestInvocationContext	DynamicTestInvocationContext represents the context of a single invocation of a dynamic test.
ExecutableInvoker	ExecutableInvoker allows invoking methods and constructors with support for dynamic resolution of parameters via ParameterResolvers.
ExecutionCondition	ExecutionCondition defines the Extension API for programmatic, conditional test execution.
Extension	Marker interface for all extensions.
ExtensionContext	ExtensionContext encapsulates the context in which the current test or container is being executed.
ExtensionContext.Store	Store provides methods for extensions to save and retrieve data.
ExtensionContext.Store.CloseableResource	Deprecated. Please extend AutoCloseable directly.
InvocationInterceptor	InvocationInterceptor defines the API for Extensions that wish to intercept calls to test code.
InvocationInterceptor.Invocation<T>	An invocation that returns a result and may throw a Throwable.
LifecycleMethodExecutionExceptionHandler	LifecycleMethodExecutionExceptionHandler defines the API for Extensions that wish to handle exceptions thrown during the execution of @BeforeAll, @BeforeEach, @AfterEach, and @AfterAll lifecycle methods.
ParameterContext	ParameterContext encapsulates the context in which an Executable will be invoked for a given Parameter.
ParameterResolver	ParameterResolver defines the API for Extensions that wish to dynamically resolve arguments for parameters at runtime.
PreInterruptCallback	PreInterruptCallback defines the API for Extensions that wish to be called prior to invocations of Thread.interrupt() by the Timeout extension.
PreInterruptContext	PreInterruptContext encapsulates the context in which an beforeThreadInterrupt method is called.
ReflectiveInvocationContext<T extends java.lang.reflect.Executable>	ReflectiveInvocationContext encapsulates the context of a reflective invocation of an executable (method or constructor).
TestExecutionExceptionHandler	TestExecutionExceptionHandler defines the API for Extensions that wish to handle exceptions thrown during test execution.
TestInstanceFactory	TestInstanceFactory defines the API for Extensions that wish to create test instances.
TestInstanceFactoryContext	TestInstanceFactoryContext encapsulates the context in which a test class is to be instantiated by a TestInstanceFactory.
TestInstancePostProcessor	TestInstancePostProcessor defines the API for Extensions that wish to post-process test instances.
TestInstancePreConstructCallback	TestInstancePreConstructCallback defines the API for Extensions that wish to be invoked prior to creation of test instances.
TestInstancePreDestroyCallback	TestInstancePreDestroyCallback defines the API for Extensions that wish to process test instances after they have been used in tests but before they are destroyed.
TestInstances	TestInstances encapsulates the test instances of a test.
TestInstantiationAwareExtension	TestInstantiationAwareExtension defines the API for Extensions that are aware of or influence the instantiation of test classes.
TestTemplateInvocationContext	TestTemplateInvocationContext represents the context of a single invocation of a test template.
TestTemplateInvocationContextProvider	TestTemplateInvocationContextProvider defines the API for Extensions that wish to provide one or multiple contexts for the invocation of a @TestTemplate method.
TestWatcher	TestWatcher defines the API for Extensions that wish to process test results.

Class Summary

Class	Description
ConditionEvaluationResult	The result of evaluating an ExecutionCondition.
ExtensionContext.Namespace	A Namespace is used to provide a scope for data saved by extensions within a ExtensionContext.Store.
MediaType	Deprecated. Use MediaType instead.

Enum Summary

Enum	Description
ExtensionContext.StoreScope	StoreScope is an enumeration of the different scopes for ExtensionContext.Store instances.
TestInstantiationAwareExtension.ExtensionContextScope	ExtensionContextScope is used to define the scope of the ExtensionContext supplied to an extension during the instantiation of test classes or processing of test instances.

Exception Summary

Exception	Description
ExtensionConfigurationException	Thrown if an error is encountered regarding the configuration of an extension.
ExtensionContextException	Thrown if an error is encountered regarding the use of an ExtensionContext or ExtensionContext.Store.
ParameterResolutionException	Thrown if an error is encountered in the configuration or execution of a ParameterResolver.
TemplateInvocationValidationException	TemplateInvocationValidationException is an exception thrown by a TestTemplateInvocationContextProvider or ClassTemplateInvocationContextProvider if a validation fails when while providing or closing Stream of invocation contexts.
TestInstantiationException	Thrown if an error is encountered during the execution of a TestInstanceFactory.

Annotation Types Summary

Annotation Type	Description
ClassTemplateInvocationLifecycleMethod	Internal marker annotation for lifecycle methods specific to implementations of ClassTemplateInvocationContextProvider.
ExtendWith	@ExtendWith is a repeatable annotation that is used to register extensions for the annotated test class, test interface, test method, parameter, or field.
Extensions	@Extensions is a container for one or more @ExtendWith declarations.
RegisterExtension	@RegisterExtension is used to register an Extension via a field in a test class.