Module org.junit.platform.suite.api
Package org.junit.platform.suite.api
Annotation Interface SuiteDisplayName
@Retention(RUNTIME)
@Target(TYPE)
@Documented
@API(status=MAINTAINED,
since="1.1")
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.
Display names are typically used for test reporting in IDEs and build tools and may contain spaces, special characters, and even emoji.
JUnit 4 Suite Support
Test suites can be run on the JUnit Platform in a JUnit 4 environment via
@RunWith(JUnitPlatform.class)
.
JUnit 5 Suite Support
Test suites can be run on the JUnit Platform in a JUnit 5 environment via
the junit-platform-suite-engine
module.
- Since:
- 1.1
- See Also:
-
Required Element Summary
-
Element Details
-
value
String valueCustom display name for the annotated class.- Returns:
- a custom display name; never blank or consisting solely of whitespace
-