Package org.junit.jupiter.api

Class DisplayNameGenerator.IndicativeSentences

java.lang.Object
org.junit.jupiter.api.DisplayNameGenerator.IndicativeSentences
All Implemented Interfaces:
DisplayNameGenerator
Enclosing interface:
DisplayNameGenerator
@API(status=EXPERIMENTAL,
     since="5.7")
public static class DisplayNameGenerator.IndicativeSentences
extends java.lang.Object
implements DisplayNameGenerator
DisplayNameGenerator that generates complete sentences.

This implements the functionality of DisplayNameGenerator by generating complete sentences display names, these sentences are divided with a separator, and the generator and separator can be customisable by using the IndicativeSentencesGeneration interface as annotation.

Since:
5.7

  • Constructor Details

    • IndicativeSentences

      public IndicativeSentences()

  • Method Details

    • generateDisplayNameForClass

      public java.lang.String generateDisplayNameForClass​(java.lang.Class<?> testClass)
      Description copied from interface: DisplayNameGenerator
      Generate a display name for the given top-level or static nested test class.
      Specified by:
      generateDisplayNameForClass in interface DisplayNameGenerator
      Parameters:
      testClass - the class to generate a name for; never null
      Returns:
      the display name for the class; never null or blank

    • generateDisplayNameForNestedClass

      public java.lang.String generateDisplayNameForNestedClass​(java.lang.Class<?> nestedClass)
      Description copied from interface: DisplayNameGenerator
      Generate a display name for the given @Nested inner test class.
      Specified by:
      generateDisplayNameForNestedClass in interface DisplayNameGenerator
      Parameters:
      nestedClass - the class to generate a name for; never null
      Returns:
      the display name for the nested class; never null or blank

    • generateDisplayNameForMethod

      public java.lang.String generateDisplayNameForMethod​(java.lang.Class<?> testClass, java.lang.reflect.Method testMethod)
      Description copied from interface: DisplayNameGenerator
      Generate a display name for the given method.
      Specified by:
      generateDisplayNameForMethod in interface DisplayNameGenerator
      Parameters:
      testClass - the class the test method is invoked on; never null
      testMethod - method to generate a display name for; never null
      Returns:
      the display name for the test; never null or blank