Top Description Annotations
module org.junit.platform.suite.api

Package org.junit.platform.suite.api

Annotations
@NullMarked
Imports
org.jspecify.annotations.NullMarked

Annotations for configuring a test suite on the JUnit Platform.

Execution

Test suites can be run on the JUnit Platform the junit-platform-suite-engine module.

Annotation Summary

Modifier and TypeAnnotation and Description
public @interface
AfterSuite

@AfterSuite is used to signal that the annotated method should be executed after all tests in the current test suite.

public @interface
BeforeSuite

@BeforeSuite is used to signal that the annotated method should be executed before all tests in the current test suite.

public @interface
ConfigurationParameter

@ConfigurationParameter is a repeatable annotation that specifies a configuration key and value pair to be added to the discovery request when running a test suite on the JUnit Platform.

public @interface
ConfigurationParameters

@ConfigurationParameters is a container for one or more @ConfigurationParameter declarations.

public @interface
ConfigurationParametersResource

@ConfigurationParametersResource is a repeatable annotation that specifies a configuration file in Java's properties format on the classpath to be added to the discovery request when running a test suite on the JUnit Platform.

public @interface
ConfigurationParametersResources

@ConfigurationParametersResources is a container for one or more @ConfigurationParametersResource declarations.

public @interface
DisableParentConfigurationParameters

Disable parent configuration parameters.

public @interface
ExcludeClassNamePatterns

@ExcludeClassNamePatterns specifies regular expressions that are used to match against fully qualified class names when running a test suite on the JUnit Platform.

public @interface
ExcludeEngines

@ExcludeEngines specifies the IDs of TestEngines to be excluded when running a test suite on the JUnit Platform.

public @interface
ExcludePackages

@ExcludePackages specifies the packages to be excluded when running a test suite on the JUnit Platform.

public @interface
ExcludeTags

@ExcludeTags specifies the tags or tag expressions to be excluded when running a test suite on the JUnit Platform.

public @interface
IncludeClassNamePatterns

@IncludeClassNamePatterns specifies regular expressions that are used to match against fully qualified class names when running a test suite on the JUnit Platform.

public @interface
IncludeEngines

@IncludeEngines specifies the IDs of TestEngines to be included when running a test suite on the JUnit Platform.

public @interface
IncludePackages

@IncludePackages specifies the packages to be included when running a test suite on the JUnit Platform.

public @interface
IncludeTags

@IncludeTags specifies the tags or tag expressions to be included when running a test suite on the JUnit Platform.

public @interface
Select

@Select is a repeatable annotation that specifies which tests to select based on prefixed selector identifiers.

public @interface
SelectClasses

@SelectClasses specifies the classes to select when running a test suite on the JUnit Platform.

public @interface
SelectClasspathResource

@SelectClasspathResource is a repeatable annotation that specifies a classpath resource to select when running a test suite on the JUnit Platform.

public @interface
SelectClasspathResources

@SelectClasspathResources is a container for one or more @SelectClasspathResource declarations.

public @interface
SelectDirectories

@SelectDirectories specifies the directories to select when running a test suite on the JUnit Platform.

public @interface
SelectFile

@SelectFile is a repeatable annotation that specifies a file to select when running a test suite on the JUnit Platform.

public @interface
SelectFiles

@SelectFiles is a container for one or more @SelectFile declarations.

public @interface
SelectMethod

@SelectMethod is a repeatable annotation that specifies a method to select when running a test suite on the JUnit Platform.

public @interface
SelectMethods

@SelectMethods is a container for one or more @SelectMethod declarations.

public @interface
SelectModules

@SelectModules specifies the modules to select when running a test suite on the JUnit Platform.

public @interface
SelectPackages

@SelectPackages specifies the names of packages to select when running a test suite on the JUnit Platform.

public @interface
Selects

@Selects is a container for one or more @Select declarations.

public @interface
SelectUris

@SelectUris specifies the URIs to select when running a test suite on the JUnit Platform.

public @interface
Suite

@Suite marks a class as a test suite on the JUnit Platform.

public @interface
SuiteDisplayName

@SuiteDisplayName is used to declare a custom display name for the annotated test class that is executed as a test suite on the JUnit Platform.