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 Object
implements DisplayNameGenerator

DisplayNameGenerator that generates complete sentences.

This generator generates display names that build up complete sentences by concatenating the names of the test and the enclosing classes. The sentence fragments are concatenated using a separator. The separator and the display name generator for individual sentence fragments can be configured via the @IndicativeSentencesGeneration annotation.

Since:

5.7

Nested Class Summary

Nested classes/interfaces inherited from interface org.junit.jupiter.api.DisplayNameGenerator

DisplayNameGenerator.IndicativeSentences, DisplayNameGenerator.ReplaceUnderscores, DisplayNameGenerator.Simple, DisplayNameGenerator.Standard

Constructor Summary

Constructors

Constructor	Description
IndicativeSentences()

Method Summary

Modifier and Type	Method	Description
String	generateDisplayNameForClass(Class<?> testClass)	Generate a display name for the given top-level or static nested test class.
String	generateDisplayNameForMethod(Class<?> testClass, Method testMethod)	Generate a display name for the given method.
String	generateDisplayNameForNestedClass(Class<?> nestedClass)	Generate a display name for the given @Nested inner test class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndicativeSentences

public IndicativeSentences()

Method Detail

generateDisplayNameForClass

public String generateDisplayNameForClass(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 String generateDisplayNameForNestedClass(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 String generateDisplayNameForMethod(Class<?> testClass,
                                           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