Module org.junit.jupiter.api

Package org.junit.jupiter.api

Annotation Interface IndicativeSentencesGeneration

@DisplayNameGeneration(IndicativeSentences.class)
@Target({ANNOTATION_TYPE,TYPE})
@Retention(RUNTIME)
@Documented
@Inherited
@API(status=STABLE,
     since="5.10")
public @interface IndicativeSentencesGeneration

@IndicativeSentencesGeneration is used to register the DisplayNameGenerator.IndicativeSentences display name generator and configure it.

The separator() for sentence fragments and the display name generator() for sentence fragments are configurable. If this annotation is declared without any attributes — for example, @IndicativeSentencesGeneration or @IndicativeSentencesGeneration() — the default configuration will be used.

This annotation is inherited from superclasses and implemented interfaces. It is also inherited from enclosing classes for @Nested test classes.

Since:

5.7

See Also:

• DisplayName
• DisplayNameGenerator
• DisplayNameGenerator.IndicativeSentences
• DisplayNameGeneration

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<? extends DisplayNameGenerator>	generator	Custom display name generator to use for sentence fragments.
String	separator	Custom separator for sentence fragments.

Field Summary

Fields

Modifier and Type	Field	Description
static final Class<? extends DisplayNameGenerator>	DEFAULT_GENERATOR
static final String	DEFAULT_SEPARATOR

Field Details

DEFAULT_SEPARATOR

static final String DEFAULT_SEPARATOR

See Also:

• Constant Field Values

DEFAULT_GENERATOR

static final Class<? extends DisplayNameGenerator> DEFAULT_GENERATOR

Element Details

separator

String separator

Custom separator for sentence fragments.

Defaults to ", ".

Default:

", "

generator

Class<? extends DisplayNameGenerator> generator

Custom display name generator to use for sentence fragments.

Defaults to DisplayNameGenerator.Standard.

Default:

org.junit.jupiter.api.DisplayNameGenerator.Standard.class