@API(status=EXPERIMENTAL,
since="5.5")
public interface LifecycleMethodExecutionExceptionHandler
extends Extension
LifecycleMethodExecutionExceptionHandler defines the API for
Extensions that wish to handle exceptions thrown during
the execution of @BeforeAll, @BeforeEach, @AfterEach,
and @AfterAll lifecycle methods.
Common use cases include swallowing an exception if it's anticipated, logging errors, or rolling back a transaction in certain error scenarios.
Implementations of this extension API must be registered at the class level
if exceptions thrown from @BeforeAll or @AfterAll methods are
to be handled. When registered at the test level, only exceptions thrown from
@BeforeEach or @AfterEach methods will be handled.
Consult the documentation in Extension for details on constructor
requirements.
An implementation of an exception handler method defined in this API must perform one of the following.
Throwable as is, which is the default implementation.Throwable, thereby preventing propagation.Throwable.If the supplied Throwable is swallowed by a handler method, subsequent
handler methods for the same lifecycle will not be invoked; otherwise, the
corresponding handler method of the next registered
LifecycleMethodExecutionExceptionHandler (if there is one) will be
invoked with any Throwable thrown by the previous handler.
TestExecutionExceptionHandler| Modifier and Type | Method and Description |
|---|---|
default void |
handleAfterAllMethodExecutionException(ExtensionContext context,
java.lang.Throwable throwable)
Handle the supplied
Throwable that was thrown during execution of
a @AfterAll lifecycle method. |
default void |
handleAfterEachMethodExecutionException(ExtensionContext context,
java.lang.Throwable throwable)
Handle the supplied
Throwable that was thrown during execution of
a @AfterEach lifecycle method. |
default void |
handleBeforeAllMethodExecutionException(ExtensionContext context,
java.lang.Throwable throwable)
Handle the supplied
Throwable that was thrown during execution of
a @BeforeAll lifecycle method. |
default void |
handleBeforeEachMethodExecutionException(ExtensionContext context,
java.lang.Throwable throwable)
Handle the supplied
Throwable that was thrown during execution of
a @BeforeEach lifecycle method. |
default void handleBeforeAllMethodExecutionException(ExtensionContext context, java.lang.Throwable throwable) throws java.lang.Throwable
Throwable that was thrown during execution of
a @BeforeAll lifecycle method.
Please refer to the class-level Javadoc for Implementation Guidelines.
context - the current extension context; never nullthrowable - the Throwable to handle; never nulljava.lang.Throwabledefault void handleBeforeEachMethodExecutionException(ExtensionContext context, java.lang.Throwable throwable) throws java.lang.Throwable
Throwable that was thrown during execution of
a @BeforeEach lifecycle method.
Please refer to the class-level Javadoc for Implementation Guidelines.
context - the current extension context; never nullthrowable - the Throwable to handle; never nulljava.lang.Throwabledefault void handleAfterEachMethodExecutionException(ExtensionContext context, java.lang.Throwable throwable) throws java.lang.Throwable
Throwable that was thrown during execution of
a @AfterEach lifecycle method.
Please refer to the class-level Javadoc for Implementation Guidelines.
context - the current extension context; never nullthrowable - the Throwable to handle; never nulljava.lang.Throwabledefault void handleAfterAllMethodExecutionException(ExtensionContext context, java.lang.Throwable throwable) throws java.lang.Throwable
Throwable that was thrown during execution of
a @AfterAll lifecycle method.
Please refer to the class-level Javadoc for Implementation Guidelines.
context - the current extension context; never nullthrowable - the Throwable to handle; never nulljava.lang.Throwable