Package org.junit.jupiter.api

Annotation Type DisplayName

@Target({TYPE,METHOD})
@Retention(RUNTIME)
@Documented
@API(status=STABLE,
     since="5.0")
public @interface DisplayName
@DisplayName is used to declare a custom display name for the annotated test class or test method.

Display names are typically used for test reporting in IDEs and build tools and may contain spaces, special characters, and even emoji.

Since:
5.0
See Also:
Test, Tag, TestInfo, DisplayNameGeneration, DisplayNameGenerator

  • Required Element Summary

    Required Elements
    Modifier and Type Required Element Description
    java.lang.String value
    Custom display name for the annotated class or method.

  • Element Details

    • value

      java.lang.String value
      Custom display name for the annotated class or method.
      Returns:
      a custom display name; never blank or consisting solely of whitespace