Package org.junit.jupiter.api

Interface DisplayNameGenerator

All Known Implementing Classes:

DisplayNameGenerator.ReplaceUnderscores, DisplayNameGenerator.Standard

@API(status=EXPERIMENTAL,
     since="5.4")
public interface DisplayNameGenerator

DisplayNameGenerator defines the SPI for generating display names programmatically.

An implementation must provide an accessible no-arg constructor.

Since:

5.4

See Also:

DisplayName, DisplayNameGeneration

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DisplayNameGenerator.ReplaceUnderscores	Replace all underscore characters with spaces.
static class	DisplayNameGenerator.Standard	Standard display name generator.

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.
static String	parameterTypesAsString(Method method)	Compile a string representation from all simple parameter type names.

Method Detail

generateDisplayNameForClass

String generateDisplayNameForClass(Class<?> testClass)

Generate a display name for the given top-level or static nested test class.

Parameters:

testClass - the class generate a name for; never null

Returns:

the display name of the container; never null or blank

generateDisplayNameForNestedClass

String generateDisplayNameForNestedClass(Class<?> nestedClass)

Generate a display name for the given @Nested inner test class.

Parameters:

nestedClass - the class generate a name for; never null

Returns:

the display name of the container; never null or blank

generateDisplayNameForMethod

String generateDisplayNameForMethod(Class<?> testClass,
                                    Method testMethod)

Generate a display name for the given method.

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 of the test; never null or blank

Implementation Note:

The class instance passed as testClass may differ from the returned class by testMethod.getDeclaringClass(): e.g., when a test method is inherited from a super class.

parameterTypesAsString

static String parameterTypesAsString(Method method)

Compile a string representation from all simple parameter type names.

Parameters:

method - the method providing parameter types for the result; never null

Returns:

a string representation of all parameter types of the supplied method or "()" if the method has no parameters