Skip navigation links
junit5-api
A B C D E F G H I M N O P R S T V 

A

AfterAll - Annotation Type in org.junit.gen5.api
@AfterAll is used to signal that the annotated method should be executed after all tests in the current test class or test class hierarchy.
afterAll(ContainerExtensionContext) - Method in interface org.junit.gen5.api.extension.AfterAllExtensionPoint
Callback that is invoked after all test methods have been invoked.
AfterAllExtensionPoint - Interface in org.junit.gen5.api.extension
AfterAllExtensionPoint defines the API for Extensions that wish to provide additional behavior to tests after all test methods have been invoked.
AfterEach - Annotation Type in org.junit.gen5.api
@AfterEach is used to signal that the annotated method should be executed after each @Test method in the current test class or test class hierarchy.
afterEach(TestExtensionContext) - Method in interface org.junit.gen5.api.extension.AfterEachExtensionPoint
Callback that is invoked after each test method has been invoked.
AfterEachExtensionPoint - Interface in org.junit.gen5.api.extension
AfterEachExtensionPoint defines the API for Extensions that wish to provide additional behavior to tests after each test method has been invoked.
assertAll(Executable...) - Static method in class org.junit.gen5.api.Assertions
Asserts that all assertions contained in asserts do not fail.
assertAll(String, Executable...) - Static method in class org.junit.gen5.api.Assertions
Asserts that all assertions contained in asserts do not fail.
assertEquals(Object, Object) - Static method in class org.junit.gen5.api.Assertions
Asserts that expected and actual are equal.
assertEquals(Object, Object, String) - Static method in class org.junit.gen5.api.Assertions
Asserts that expected and actual are equal.
assertEquals(Object, Object, Supplier<String>) - Static method in class org.junit.gen5.api.Assertions
Asserts that expected and actual are equal.
assertFalse(boolean) - Static method in class org.junit.gen5.api.Assertions
Asserts that condition is not true.
assertFalse(boolean, String) - Static method in class org.junit.gen5.api.Assertions
Asserts that condition is not true.
assertFalse(boolean, Supplier<String>) - Static method in class org.junit.gen5.api.Assertions
Asserts that condition is not true.
assertFalse(BooleanSupplier) - Static method in class org.junit.gen5.api.Assertions
Asserts that condition supplied by booleanSupplier is not true.
assertFalse(BooleanSupplier, String) - Static method in class org.junit.gen5.api.Assertions
Asserts that condition supplied by booleanSupplier is not true.
assertFalse(BooleanSupplier, Supplier<String>) - Static method in class org.junit.gen5.api.Assertions
Asserts that condition supplied by booleanSupplier is not true.
Assertions - Class in org.junit.gen5.api
Assertions is a collection of utility methods that support asserting conditions in tests.
assertNotEquals(Object, Object) - Static method in class org.junit.gen5.api.Assertions
Asserts that expected and actual are not equal.
assertNotEquals(Object, Object, String) - Static method in class org.junit.gen5.api.Assertions
Asserts that expected and actual are not equal.
assertNotEquals(Object, Object, Supplier<String>) - Static method in class org.junit.gen5.api.Assertions
Asserts that expected and actual are not equal.
assertNotNull(Object) - Static method in class org.junit.gen5.api.Assertions
Asserts that actual is not null.
assertNotNull(Object, String) - Static method in class org.junit.gen5.api.Assertions
Asserts that actual is not null.
assertNotNull(Object, Supplier<String>) - Static method in class org.junit.gen5.api.Assertions
Asserts that actual is not null.
assertNotSame(Object, Object) - Static method in class org.junit.gen5.api.Assertions
Asserts that expected and actual do not refer to the same object.
assertNotSame(Object, Object, String) - Static method in class org.junit.gen5.api.Assertions
Asserts that expected and actual do not refer to the same object.
assertNotSame(Object, Object, Supplier<String>) - Static method in class org.junit.gen5.api.Assertions
Asserts that expected and actual do not refer to the same object.
assertNull(Object) - Static method in class org.junit.gen5.api.Assertions
Asserts that actual is null.
assertNull(Object, String) - Static method in class org.junit.gen5.api.Assertions
Asserts that actual is null.
assertNull(Object, Supplier<String>) - Static method in class org.junit.gen5.api.Assertions
Asserts that actual is null.
assertSame(Object, Object) - Static method in class org.junit.gen5.api.Assertions
Asserts that expected and actual refer to the same object.
assertSame(Object, Object, String) - Static method in class org.junit.gen5.api.Assertions
Asserts that expected and actual refer to the same object.
assertSame(Object, Object, Supplier<String>) - Static method in class org.junit.gen5.api.Assertions
Asserts that expected and actual refer to the same object.
assertThrows(Class<? extends Throwable>, Executable) - Static method in class org.junit.gen5.api.Assertions
Asserts that executing executable will throw an exception of type expected.
assertTrue(boolean) - Static method in class org.junit.gen5.api.Assertions
Asserts that condition is true.
assertTrue(boolean, Supplier<String>) - Static method in class org.junit.gen5.api.Assertions
Asserts that condition is true.
assertTrue(BooleanSupplier) - Static method in class org.junit.gen5.api.Assertions
Asserts that condition supplied by booleanSupplier is true.
assertTrue(BooleanSupplier, String) - Static method in class org.junit.gen5.api.Assertions
Asserts that condition supplied by booleanSupplier is true.
assertTrue(boolean, String) - Static method in class org.junit.gen5.api.Assertions
Asserts that condition is true.
assertTrue(BooleanSupplier, Supplier<String>) - Static method in class org.junit.gen5.api.Assertions
Asserts that condition supplied by booleanSupplier is true.
assumeFalse(boolean) - Static method in class org.junit.gen5.api.Assumptions
Validate the given assumption.
assumeFalse(BooleanSupplier) - Static method in class org.junit.gen5.api.Assumptions
Validate the given assumption.
assumeFalse(BooleanSupplier, String) - Static method in class org.junit.gen5.api.Assumptions
Validate the given assumption.
assumeFalse(boolean, Supplier<String>) - Static method in class org.junit.gen5.api.Assumptions
Validate the given assumption.
assumeFalse(boolean, String) - Static method in class org.junit.gen5.api.Assumptions
Validate the given assumption.
assumeFalse(BooleanSupplier, Supplier<String>) - Static method in class org.junit.gen5.api.Assumptions
Validate the given assumption.
assumeTrue(boolean) - Static method in class org.junit.gen5.api.Assumptions
Validate the given assumption.
assumeTrue(BooleanSupplier) - Static method in class org.junit.gen5.api.Assumptions
Validate the given assumption.
assumeTrue(BooleanSupplier, String) - Static method in class org.junit.gen5.api.Assumptions
Validate the given assumption.
assumeTrue(boolean, Supplier<String>) - Static method in class org.junit.gen5.api.Assumptions
Validate the given assumption.
assumeTrue(boolean, String) - Static method in class org.junit.gen5.api.Assumptions
Validate the given assumption.
assumeTrue(BooleanSupplier, Supplier<String>) - Static method in class org.junit.gen5.api.Assumptions
Validate the given assumption.
assumingThat(BooleanSupplier, Executable) - Static method in class org.junit.gen5.api.Assumptions
Execute the supplied Executable, but only if the supplied assumption is valid.
assumingThat(boolean, Executable) - Static method in class org.junit.gen5.api.Assumptions
Execute the supplied Executable, but only if the supplied assumption is valid.
Assumptions - Class in org.junit.gen5.api
Assumptions is a collection of utility methods that support conditional test execution based on assumptions.

B

BeforeAll - Annotation Type in org.junit.gen5.api
@BeforeAll is used to signal that the annotated method should be executed before all tests in the current test class or test class hierarchy.
beforeAll(ContainerExtensionContext) - Method in interface org.junit.gen5.api.extension.BeforeAllExtensionPoint
Callback that is invoked before all @BeforeAll methods have been invoked.
BeforeAllExtensionPoint - Interface in org.junit.gen5.api.extension
BeforeAllExtensionPoint defines the API for Extensions that wish to provide additional behavior to tests before all test methods have been invoked.
BeforeEach - Annotation Type in org.junit.gen5.api
@BeforeEach is used to signal that the annotated method should be executed before each @Test method in the current test class or test class hierarchy.
beforeEach(TestExtensionContext) - Method in interface org.junit.gen5.api.extension.BeforeEachExtensionPoint
Callback that is invoked before each test method has been invoked.
BeforeEachExtensionPoint - Interface in org.junit.gen5.api.extension
BeforeEachExtensionPoint defines the API for Extensions that wish to provide additional behavior to tests before each test method has been invoked.

C

ConditionEvaluationResult - Class in org.junit.gen5.api.extension
ContainerExecutionCondition - Interface in org.junit.gen5.api.extension
ContainerExecutionCondition defines an ExtensionPoint for programmatic, conditional container execution.
ContainerExtensionContext - Interface in org.junit.gen5.api.extension
ContainerExtensionContext encapsulates the context in which the current container is being executed.

D

DEFAULT - Static variable in class org.junit.gen5.api.extension.ExtensionContext.Namespace
The default namespace which allows access to stored data from all extensions.
Disabled - Annotation Type in org.junit.gen5.api
@Disabled is used to signal that the annotated test class or test method is currently disabled and should not be executed.
disabled(String) - Static method in class org.junit.gen5.api.extension.ConditionEvaluationResult
Factory for creating disabled results.
DisplayName - Annotation Type in org.junit.gen5.api
@DisplayName is used to declare a custom display name for the annotated test class or test method.

E

enabled(String) - Static method in class org.junit.gen5.api.extension.ConditionEvaluationResult
Factory for creating enabled results.
equals(Object) - Method in class org.junit.gen5.api.extension.ExtensionContext.Namespace
 
evaluate(ContainerExtensionContext) - Method in interface org.junit.gen5.api.extension.ContainerExecutionCondition
Evaluate this condition for the supplied ContainerExtensionContext.
evaluate(TestExtensionContext) - Method in interface org.junit.gen5.api.extension.TestExecutionCondition
Evaluate this condition for the supplied TestExtensionContext.
ExceptionHandlerExtensionPoint - Interface in org.junit.gen5.api.extension
ExceptionHandlerExtensionPoint defines the API for Extensions that wish to react to thrown exceptions in tests.
Executable - Interface in org.junit.gen5.api
Executable is a functional interface that can be used to implement any generic block of code that potentially throws a Throwable.
execute() - Method in interface org.junit.gen5.api.Executable
 
expectThrows(Class<T>, Executable) - Static method in class org.junit.gen5.api.Assertions
Asserts that executing executable will throw an exception of type expected.
ExtendWith - Annotation Type in org.junit.gen5.api.extension
@ExtendWith is a repeatable annotation that is used to register extensions for the annotated test class or test method.
Extension - Interface in org.junit.gen5.api.extension
Marker interface for all extensions.
ExtensionConfigurationException - Exception in org.junit.gen5.api.extension
Thrown if an error is encountered regarding the configuration of an extension.
ExtensionConfigurationException(String) - Constructor for exception org.junit.gen5.api.extension.ExtensionConfigurationException
 
ExtensionContext - Interface in org.junit.gen5.api.extension
ExtensionContext encapsulates the context in which the current test or container is being executed.
ExtensionContext.Namespace - Class in org.junit.gen5.api.extension
Instances of this class are used to give saved data in extensions a scope, so that extensions won't accidentally mix up data across each other or across different invocations within their lifecycle.
ExtensionContext.Store - Interface in org.junit.gen5.api.extension
Store provides methods for extensions to save and retrieve data.
ExtensionPoint - Interface in org.junit.gen5.api.extension
Super interface for all extension points.
ExtensionPointRegistry - Interface in org.junit.gen5.api.extension
A registry for ExtensionPoint implementations which can be populated via an ExtensionRegistrar.
ExtensionPointRegistry.Position - Enum in org.junit.gen5.api.extension
Position specifies the position in which a registered ExtensionPoint is applied with regard to all other registered extension points of the same type.
ExtensionRegistrar - Interface in org.junit.gen5.api.extension
Interface to be implemented by extensions that wish to programmatically register ExtensionPoint implementations in the ExtensionPointRegistry — for example, if a Position other than DEFAULT is desired.
Extensions - Annotation Type in org.junit.gen5.api.extension
@Extensions is a container for one or more @ExtendWith declarations.

F

fail(String) - Static method in class org.junit.gen5.api.Assertions
Fails a test with a given message.
fail(Supplier<String>) - Static method in class org.junit.gen5.api.Assertions
Fails a test and retrieve failure message from messageSupplier.

G

get(Object) - Method in interface org.junit.gen5.api.extension.ExtensionContext.Store
Get an object that has been stored using a key.
getDisplayName() - Method in interface org.junit.gen5.api.extension.ExtensionContext
Get the display name for the current test or container.
getDisplayName() - Method in interface org.junit.gen5.api.TestInfo
Get the display name of the current test.
getElement() - Method in interface org.junit.gen5.api.extension.ExtensionContext
Get the AnnotatedElement corresponding to the current extension context.
getInstance() - Method in interface org.junit.gen5.api.extension.MethodInvocationContext
 
getMethod() - Method in interface org.junit.gen5.api.extension.MethodInvocationContext
 
getName() - Method in interface org.junit.gen5.api.extension.ExtensionContext
Get the name for the current test or container.
getName() - Method in interface org.junit.gen5.api.TestInfo
Get the name of the current test.
getOrComputeIfAbsent(Object, Function<Object, Object>) - Method in interface org.junit.gen5.api.extension.ExtensionContext.Store
Get the object that is stored under the supplied key.
getParent() - Method in interface org.junit.gen5.api.extension.ExtensionContext
Get the parent extension context if there is one.
getReason() - Method in class org.junit.gen5.api.extension.ConditionEvaluationResult
 
getStore() - Method in interface org.junit.gen5.api.extension.ExtensionContext
getStore(ExtensionContext.Namespace) - Method in interface org.junit.gen5.api.extension.ExtensionContext
getTestClass() - Method in interface org.junit.gen5.api.extension.ExtensionContext
Get the Class associated with the current test or container.
getTestInstance() - Method in interface org.junit.gen5.api.extension.TestExtensionContext
 
getTestMethod() - Method in interface org.junit.gen5.api.extension.TestExtensionContext
 
getUniqueId() - Method in interface org.junit.gen5.api.extension.ExtensionContext
Get the unique id of the current test or container.

H

handleException(TestExtensionContext, Throwable) - Method in interface org.junit.gen5.api.extension.ExceptionHandlerExtensionPoint
React to a throwable which has been thrown by a test method.
hashCode() - Method in class org.junit.gen5.api.extension.ExtensionContext.Namespace
 

I

InstancePostProcessor - Interface in org.junit.gen5.api.extension
InstancePostProcessor defines the API for Extensions that wish to post-process test instances.
isDisabled() - Method in class org.junit.gen5.api.extension.ConditionEvaluationResult
 

M

MethodInvocationContext - Interface in org.junit.gen5.api.extension
MethodInvocationContext encapsulates the context in which a method is to be invoked.
MethodParameterResolver - Interface in org.junit.gen5.api.extension
MethodParameterResolver defines the API for Extensions that wish to dynamically resolve method parameters at runtime.

N

Nested - Annotation Type in org.junit.gen5.api
@Nested is used to signal that the annotated class is a nested, non-static test class.

O

of(Object...) - Static method in class org.junit.gen5.api.extension.ExtensionContext.Namespace
Create a namespace which restricts access to data to all users which use the same parts for creating a namespace.
org.junit.gen5.api - package org.junit.gen5.api
JUnit 5 API for writing tests.
org.junit.gen5.api.extension - package org.junit.gen5.api.extension
JUnit 5 API for writing extensions.

P

ParameterResolutionException - Exception in org.junit.gen5.api.extension
Thrown if an error is encountered in the configuration or execution of a MethodParameterResolver.
ParameterResolutionException(String) - Constructor for exception org.junit.gen5.api.extension.ParameterResolutionException
 
ParameterResolutionException(String, Throwable) - Constructor for exception org.junit.gen5.api.extension.ParameterResolutionException
 
postProcessTestInstance(TestExtensionContext) - Method in interface org.junit.gen5.api.extension.InstancePostProcessor
Callback for post-processing the test instance in the supplied TestExtensionContext.
publishEntry(Map<String, String>) - Method in interface org.junit.gen5.api.TestReporter
Publish the supplied values as a report entry.
publishEntry(String, String) - Method in interface org.junit.gen5.api.TestReporter
 
publishReportEntry(Map<String, String>) - Method in interface org.junit.gen5.api.extension.ExtensionContext
Publish a map of values to be consumed by an org.junit.gen5.engine.EngineExecutionListener.
put(Object, Object) - Method in interface org.junit.gen5.api.extension.ExtensionContext.Store
Store a value for later retrieval using a key.

R

register(ExtensionPoint) - Method in interface org.junit.gen5.api.extension.ExtensionPointRegistry
Register the supplied ExtensionPoint using the default position.
register(ExtensionPoint, ExtensionPointRegistry.Position) - Method in interface org.junit.gen5.api.extension.ExtensionPointRegistry
Register the supplied ExtensionPoint using the supplied ExtensionPointRegistry.Position.
registerExtensions(ExtensionPointRegistry) - Method in interface org.junit.gen5.api.extension.ExtensionRegistrar
 
remove(Object) - Method in interface org.junit.gen5.api.extension.ExtensionContext.Store
Remove a value that was previously stored using key so that key can be used anew.
resolve(Parameter, MethodInvocationContext, ExtensionContext) - Method in interface org.junit.gen5.api.extension.MethodParameterResolver
Resolve the given Parameter for the supplied MethodInvocationContext and ExtensionContext.

S

supports(Parameter, MethodInvocationContext, ExtensionContext) - Method in interface org.junit.gen5.api.extension.MethodParameterResolver
Determine if this resolver supports resolution of the given Parameter for the supplied MethodInvocationContext and ExtensionContext.

T

Tag - Annotation Type in org.junit.gen5.api
@Tag is a repeatable annotation that is used to declare a tag for the annotated test class or test method.
Tags - Annotation Type in org.junit.gen5.api
@Tags is a container for one or more @Tag declarations.
Test - Annotation Type in org.junit.gen5.api
@Test is used to signal that the annotated method is a test method.
TestExecutionCondition - Interface in org.junit.gen5.api.extension
TestExecutionCondition defines an ExtensionPoint for programmatic, conditional test execution.
TestExtensionContext - Interface in org.junit.gen5.api.extension
TestExtensionContext encapsulates the context in which the current test is being executed.
TestInfo - Interface in org.junit.gen5.api
TestInfo is used to inject information about the current test into to @Test, @BeforeEach, @AfterEach, @BeforeAll, and @AfterAll methods.
TestReporter - Interface in org.junit.gen5.api
Parameters of type TestReporter can be injected into methods of test classes annotated with @BeforeEach, @AfterEach, and @Test.
toString() - Method in class org.junit.gen5.api.extension.ConditionEvaluationResult
 

V

valueOf(String) - Static method in enum org.junit.gen5.api.extension.ExtensionPointRegistry.Position
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.junit.gen5.api.extension.ExtensionPointRegistry.Position
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E F G H I M N O P R S T V 
Skip navigation links
junit5-api