Module org.junit.jupiter.api
Package org.junit.jupiter.api.extension
JUnit Jupiter API for writing extensions.
-
Interface Summary Interface Description AfterAllCallback AfterAllCallback
defines the API forExtensions
that wish to provide additional behavior to test containers once after all tests in the container have been executed.AfterEachCallback AfterEachCallback
defines the API forExtensions
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 forExtensions
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.BeforeAllCallback BeforeAllCallback
defines the API forExtensions
that wish to provide additional behavior to test containers once before all tests in the container have been executed.BeforeEachCallback BeforeEachCallback
defines the API forExtensions
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 forExtensions
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.ExecutionCondition ExecutionCondition
defines theExtension
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 Classes implementing this interface indicate that they want toExtensionContext.Store.CloseableResource.close()
some underlying resource or resources when the enclosingStore
is closed.InvocationInterceptor InvocationInterceptor
defines the API forExtensions
that wish to intercept calls to test code.InvocationInterceptor.Invocation<T> An invocation that returns a result and may throw aThrowable
.LifecycleMethodExecutionExceptionHandler LifecycleMethodExecutionExceptionHandler
defines the API forExtensions
that wish to handle exceptions thrown during the execution of@BeforeAll
,@BeforeEach
,@AfterEach
, and@AfterAll
lifecycle methods.ParameterContext ParameterContext
encapsulates the context in which anExecutable
will be invoked for a givenParameter
.ParameterResolver ParameterResolver
defines the API forExtensions
that wish to dynamically resolve arguments for parameters at runtime.ReflectiveInvocationContext<T extends Executable> ReflectiveInvocationContext
encapsulates the context of a reflective invocation of an executable (method or constructor).TestExecutionExceptionHandler TestExecutionExceptionHandler
defines the API forExtensions
that wish to handle exceptions thrown during test execution.TestInstanceFactory TestInstanceFactoryContext TestInstanceFactoryContext
encapsulates the context in which a test class is to be instantiated by aTestInstanceFactory
.TestInstancePostProcessor TestInstancePostProcessor
defines the API forExtensions
that wish to post-process test instances.TestInstancePreDestroyCallback TestInstancePreDestroyCallback
defines the API forExtensions
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.TestTemplateInvocationContext TestTemplateInvocationContext
represents the context of a single invocation of a test template.TestTemplateInvocationContextProvider TestTemplateInvocationContextProvider
defines the API forExtensions
that wish to provide one or multiple contexts for the invocation of a@TestTemplate
method.TestWatcher TestWatcher
defines the API forExtensions
that wish to process test results. -
Class Summary Class Description ConditionEvaluationResult The result of evaluating an ExecutionCondition.ExtensionContext.Namespace ANamespace
is used to provide a scope for data saved by extensions within aExtensionContext.Store
. -
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 anExtensionContext
orExtensionContext.Store
.ParameterResolutionException Thrown if an error is encountered in the configuration or execution of aParameterResolver
.TestInstantiationException Thrown if an error is encountered during the execution of aTestInstanceFactory
. -
Annotation Types Summary Annotation Type Description ExtendWith @ExtendWith
is a repeatable annotation that is used to register extensions for the annotated test class or test method.Extensions @Extensions
is a container for one or more@ExtendWith
declarations.RegisterExtension @RegisterExtension
is used to register anExtension
via a field in a test class.