org.junit.jupiter.params

pack-priv Class ParameterizedInvocationNameFormatter

Class Inheritance

extends Object

java.lang.Object
org.junit.jupiter.params.ParameterizedInvocationNameFormatter

Static Imports

java.util.Objects.requireNonNull, org.junit.jupiter.params.ParameterizedInvocationConstants.ARGUMENTS_PLACEHOLDER, .ParameterizedInvocationConstants.ARGUMENTS_WITH_NAMES_PLACEHOLDER, .ParameterizedInvocationConstants.ARGUMENT_SET_NAME_OR_ARGUMENTS_WITH_NAMES_PLACEHOLDER, .ParameterizedInvocationConstants.ARGUMENT_SET_NAME_PLACEHOLDER, .ParameterizedInvocationConstants.DISPLAY_NAME_PLACEHOLDER, .ParameterizedInvocationConstants.INDEX_PLACEHOLDER, org.junit.platform.commons.util.StringUtils.isNotBlank

Since: 5.0

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static record	ParameterizedInvocationNameFormatter.ArgumentsContext
private static record	ParameterizedInvocationNameFormatter.ArgumentSetNameFormatter
private static class	ParameterizedInvocationNameFormatter.CachingByArgumentsLengthPartialFormatter Caches formatters by the length of the consumed arguments which may differ from the number of declared parameters.
private static class	ParameterizedInvocationNameFormatter.MessageFormatPartialFormatter
private static interface	ParameterizedInvocationNameFormatter.PartialFormatter
private static class	ParameterizedInvocationNameFormatter.PartialFormatters
private static record	ParameterizedInvocationNameFormatter.PlaceholderPosition

Field Summary

Modifier and Type	Field and Description
pack-priv static final String	ARGUMENT_MAX_LENGTH_KEY
private static final Map<Integer, String>	argumentsPatternCache Global cache for {arguments} pattern strings, keyed by the number of arguments.
pack-priv static final String	DEFAULT_DISPLAY_NAME
pack-priv static final String	DEFAULT_DISPLAY_NAME_PATTERN
pack-priv static final String	DISPLAY_NAME_PATTERN_KEY
private final ParameterizedInvocationNameFormatter.PartialFormatter[]	partialFormatters

Constructor Summary

Access	Constructor and Description
pack-priv	ParameterizedInvocationNameFormatter(String pattern, String displayName, ParameterizedDeclarationContext<?> declarationContext, int argumentMaxLength)

Method Summary

Modifier and Type	Method and Description
private static String	argumentsPattern(int length)
pack-priv static ParameterizedInvocationNameFormatter	create(ExtensionContext extensionContext, ParameterizedDeclarationContext<?> declarationContext)
private ParameterizedInvocationNameFormatter.PartialFormatters	createPartialFormatters(String displayName, ParameterizedDeclarationContext<?> declarationContext, int argumentMaxLength)
private static ParameterizedInvocationNameFormatter.PartialFormatter	determineNonPlaceholderFormatter(String segment, int argumentMaxLength)
private static @Nullable ParameterizedInvocationNameFormatter.PlaceholderPosition	findFirstPlaceholder(ParameterizedInvocationNameFormatter.PartialFormatters formatters, String segment)
pack-priv String	format(int invocationIndex, EvaluatedArgumentSet arguments, boolean quoteTextArguments)
private String	formatSafely(int invocationIndex, EvaluatedArgumentSet arguments, boolean quoteTextArguments)
private ParameterizedInvocationNameFormatter.PartialFormatter[]	parse(String pattern, String displayName, ParameterizedDeclarationContext<?> declarationContext, int argumentMaxLength)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ARGUMENT_MAX_LENGTH_KEY	back to summary
pack-priv static final String ARGUMENT_MAX_LENGTH_KEY

argumentsPatternCache	back to summary
private static final Map<Integer, String> argumentsPatternCache Global cache for {arguments} pattern strings, keyed by the number of arguments. Since 6.0

argumentsPatternCache

back to summary

private static final Map<Integer, String> argumentsPatternCache

Global cache for {arguments} pattern strings, keyed by the number of arguments.

Since: 6.0

DEFAULT_DISPLAY_NAME	back to summary
pack-priv static final String DEFAULT_DISPLAY_NAME

DEFAULT_DISPLAY_NAME_PATTERN	back to summary
pack-priv static final String DEFAULT_DISPLAY_NAME_PATTERN

DISPLAY_NAME_PATTERN_KEY	back to summary
pack-priv static final String DISPLAY_NAME_PATTERN_KEY

partialFormatters	back to summary
private final ParameterizedInvocationNameFormatter.PartialFormatter[] partialFormatters

Constructor Detail

ParameterizedInvocationNameFormatter	back to summary
pack-priv ParameterizedInvocationNameFormatter(String pattern, String displayName, ParameterizedDeclarationContext<?> declarationContext, int argumentMaxLength)

Method Detail

argumentsPattern	back to summary
private static String argumentsPattern(int length)

create	back to summary
pack-priv static ParameterizedInvocationNameFormatter create(ExtensionContext extensionContext, ParameterizedDeclarationContext<?> declarationContext)

createPartialFormatters	back to summary
private ParameterizedInvocationNameFormatter.PartialFormatters createPartialFormatters(String displayName, ParameterizedDeclarationContext<?> declarationContext, int argumentMaxLength)

determineNonPlaceholderFormatter	back to summary
private static ParameterizedInvocationNameFormatter.PartialFormatter determineNonPlaceholderFormatter(String segment, int argumentMaxLength)

findFirstPlaceholder	back to summary
private static @Nullable ParameterizedInvocationNameFormatter.PlaceholderPosition findFirstPlaceholder(ParameterizedInvocationNameFormatter.PartialFormatters formatters, String segment)

format	back to summary
pack-priv String format(int invocationIndex, EvaluatedArgumentSet arguments, boolean quoteTextArguments)

formatSafely	back to summary
private String formatSafely(int invocationIndex, EvaluatedArgumentSet arguments, boolean quoteTextArguments) Annotations @SuppressWarnings:JdkObsolete

parse	back to summary
private ParameterizedInvocationNameFormatter.PartialFormatter[] parse(String pattern, String displayName, ParameterizedDeclarationContext<?> declarationContext, int argumentMaxLength)

org.junit.jupiter.params back to summary

private final Record ParameterizedInvocationNameFormatter.ArgumentsContext

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.junit.jupiter.params.ParameterizedInvocationNameFormatter.ArgumentsContext

Annotations

@SuppressWarnings:ArrayRecordComponent

Record Components

invocationIndex:int
consumedArguments:@Nullable Object[]
argumentSetName:Optional<String>
quoteTextArguments:boolean

Field Summary

Modifier and Type	Field and Description
private final Optional<String>	argumentSetName Record Component accessed by argumentSetName().
private final @Nullable Object[]	consumedArguments Record Component accessed by consumedArguments().
private final int	invocationIndex Record Component accessed by invocationIndex().
private final boolean	quoteTextArguments Record Component accessed by quoteTextArguments().

Constructor Summary

Access	Constructor and Description
private	ArgumentsContext(int invocationIndex, @Nullable Object[] consumedArguments, Optional<String> argumentSetName, boolean quoteTextArguments)

Method Summary

Modifier and Type	Method and Description
public Optional<String>	argumentSetName() Record Component getter of argumentSetName.
public @Nullable Object[]	consumedArguments() Record Component getter of consumedArguments.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public int	invocationIndex() Record Component getter of invocationIndex.
public boolean	quoteTextArguments() Record Component getter of quoteTextArguments.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

argumentSetName	back to summary
private final Optional<String> argumentSetName Record Component accessed by argumentSetName().

consumedArguments	back to summary
private final @Nullable Object[] consumedArguments Record Component accessed by consumedArguments().

invocationIndex	back to summary
private final int invocationIndex Record Component accessed by invocationIndex().

quoteTextArguments	back to summary
private final boolean quoteTextArguments Record Component accessed by quoteTextArguments().

Constructor Detail

ArgumentsContext	back to summary
private ArgumentsContext(int invocationIndex, @Nullable Object[] consumedArguments, Optional<String> argumentSetName, boolean quoteTextArguments)

Method Detail

argumentSetName	back to summary
public Optional<String> argumentSetName() Record Component getter of argumentSetName.

consumedArguments	back to summary
public @Nullable Object[] consumedArguments() Record Component getter of consumedArguments.

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

invocationIndex	back to summary
public int invocationIndex() Record Component getter of invocationIndex.

quoteTextArguments	back to summary
public boolean quoteTextArguments() Record Component getter of quoteTextArguments.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

org.junit.jupiter.params back to summary

private final Record ParameterizedInvocationNameFormatter.ArgumentSetNameFormatter

Class Inheritance

extends Record
implements PartialFormatter

java.lang.Object
java.lang.Record
org.junit.jupiter.params.ParameterizedInvocationNameFormatter.ArgumentSetNameFormatter

All Implemented Interfaces

org.junit.jupiter.params.ParameterizedInvocationNameFormatter.PartialFormatter

Record Components

annotationName:String

Field Summary

Modifier and Type	Field and Description
private final String	annotationName Record Component accessed by annotationName().

Constructor Summary

Access	Constructor and Description
private	ArgumentSetNameFormatter(String annotationName)

Method Summary

Modifier and Type	Method and Description
public String	annotationName() Record Component getter of annotationName.
public void	append(ParameterizedInvocationNameFormatter.ArgumentsContext context, StringBuffer result) Implements org.junit.jupiter.params.ParameterizedInvocationNameFormatter.PartialFormatter.append.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

annotationName	back to summary
private final String annotationName Record Component accessed by annotationName().

Constructor Detail

ArgumentSetNameFormatter	back to summary
private ArgumentSetNameFormatter(String annotationName)

Method Detail

annotationName	back to summary
public String annotationName() Record Component getter of annotationName.

append	back to summary
public void append(ParameterizedInvocationNameFormatter.ArgumentsContext context, StringBuffer result) Implements org.junit.jupiter.params.ParameterizedInvocationNameFormatter.PartialFormatter.append. Annotations @Override

append

back to summary

public void append(ParameterizedInvocationNameFormatter.ArgumentsContext context, StringBuffer result)

Implements org.junit.jupiter.params.ParameterizedInvocationNameFormatter.PartialFormatter.append.

Annotations

@Override

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

org.junit.jupiter.params back to summary

private Class ParameterizedInvocationNameFormatter.CachingByArgumentsLengthPartialFormatter

Class Inheritance

extends Object
implements PartialFormatter

java.lang.Object
org.junit.jupiter.params.ParameterizedInvocationNameFormatter.CachingByArgumentsLengthPartialFormatter

All Implemented Interfaces

org.junit.jupiter.params.ParameterizedInvocationNameFormatter.PartialFormatter

Caches formatters by the length of the consumed arguments which may differ from the number of declared parameters.

For example, when using multiple providers or a provider that returns argument arrays of different length, such as:

@ParameterizedTest
@CsvSource({"a", "a,b", "a,b,c"})
void test(ArgumentsAccessor accessor) {}

Field Summary

Modifier and Type	Field and Description
private final ConcurrentMap<Integer, ParameterizedInvocationNameFormatter.PartialFormatter>	cache
private final Function<Integer, ParameterizedInvocationNameFormatter.PartialFormatter>	factory

Constructor Summary

Access	Constructor and Description
pack-priv	CachingByArgumentsLengthPartialFormatter(Function<Integer, ParameterizedInvocationNameFormatter.PartialFormatter> factory)

Method Summary

Modifier and Type	Method and Description
public void	append(ParameterizedInvocationNameFormatter.ArgumentsContext context, StringBuffer result) Implements org.junit.jupiter.params.ParameterizedInvocationNameFormatter.PartialFormatter.append.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cache	back to summary
private final ConcurrentMap<Integer, ParameterizedInvocationNameFormatter.PartialFormatter> cache

factory	back to summary
private final Function<Integer, ParameterizedInvocationNameFormatter.PartialFormatter> factory

Constructor Detail

CachingByArgumentsLengthPartialFormatter	back to summary
pack-priv CachingByArgumentsLengthPartialFormatter(Function<Integer, ParameterizedInvocationNameFormatter.PartialFormatter> factory)

Method Detail

append

back to summary

public void append(ParameterizedInvocationNameFormatter.ArgumentsContext context, StringBuffer result)

Implements org.junit.jupiter.params.ParameterizedInvocationNameFormatter.PartialFormatter.append.

Annotations

@Override

org.junit.jupiter.params back to summary

private Class ParameterizedInvocationNameFormatter.MessageFormatPartialFormatter

Class Inheritance

extends Object
implements PartialFormatter

java.lang.Object
org.junit.jupiter.params.ParameterizedInvocationNameFormatter.MessageFormatPartialFormatter

All Implemented Interfaces

org.junit.jupiter.params.ParameterizedInvocationNameFormatter.PartialFormatter

Field Summary

Modifier and Type	Field and Description
private final int	argumentMaxLength
private static final char	ELLIPSIS
private final boolean	generateNameValuePairs
private final MessageFormat	messageFormat
private final @Nullable ResolverFacade	resolverFacade

Constructor Summary

Access	Constructor and Description
pack-priv	MessageFormatPartialFormatter(String pattern, int argumentMaxLength)
pack-priv	MessageFormatPartialFormatter(String pattern, int argumentMaxLength, boolean generateNameValuePairs, @Nullable ResolverFacade resolverFacade)

Method Summary

Modifier and Type	Method and Description
public synchronized void	append(ParameterizedInvocationNameFormatter.ArgumentsContext context, StringBuffer result) Implements org.junit.jupiter.params.ParameterizedInvocationNameFormatter.PartialFormatter.append.
private @Nullable Object[]	makeReadable(@Nullable Object[] arguments, boolean quoteTextArguments)
private String	truncateIfExceedsMaxLength(String argument)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

argumentMaxLength	back to summary
private final int argumentMaxLength

ELLIPSIS	back to summary
private static final char ELLIPSIS Annotations @SuppressWarnings:UnnecessaryUnicodeEscape

generateNameValuePairs	back to summary
private final boolean generateNameValuePairs

messageFormat	back to summary
private final MessageFormat messageFormat

resolverFacade	back to summary
private final @Nullable ResolverFacade resolverFacade

Constructor Detail

MessageFormatPartialFormatter	back to summary
pack-priv MessageFormatPartialFormatter(String pattern, int argumentMaxLength)

MessageFormatPartialFormatter	back to summary
pack-priv MessageFormatPartialFormatter(String pattern, int argumentMaxLength, boolean generateNameValuePairs, @Nullable ResolverFacade resolverFacade)

Method Detail

append

back to summary

public synchronized void append(ParameterizedInvocationNameFormatter.ArgumentsContext context, StringBuffer result)

Implements org.junit.jupiter.params.ParameterizedInvocationNameFormatter.PartialFormatter.append.

Annotations

@Override

makeReadable	back to summary
private @Nullable Object[] makeReadable(@Nullable Object[] arguments, boolean quoteTextArguments)

truncateIfExceedsMaxLength	back to summary
private String truncateIfExceedsMaxLength(String argument)

org.junit.jupiter.params back to summary

private Interface ParameterizedInvocationNameFormatter.PartialFormatter

Known Direct Implementers

org.junit.jupiter.params.ParameterizedInvocationNameFormatter.ArgumentSetNameFormatter, org.junit.jupiter.params.ParameterizedInvocationNameFormatter.MessageFormatPartialFormatter, org.junit.jupiter.params.ParameterizedInvocationNameFormatter.CachingByArgumentsLengthPartialFormatter

Annotations

@FunctionalInterface

Field Summary

Modifier and Type	Field and Description
public static final ParameterizedInvocationNameFormatter.PartialFormatter	INDEX

Method Summary

Modifier and Type	Method and Description
public void	append(ParameterizedInvocationNameFormatter.ArgumentsContext context, StringBuffer result)

Field Detail

INDEX	back to summary
public static final ParameterizedInvocationNameFormatter.PartialFormatter INDEX

Method Detail

append	back to summary
public void append(ParameterizedInvocationNameFormatter.ArgumentsContext context, StringBuffer result)

org.junit.jupiter.params back to summary

private Class ParameterizedInvocationNameFormatter.PartialFormatters

Class Inheritance

extends Object

java.lang.Object
org.junit.jupiter.params.ParameterizedInvocationNameFormatter.PartialFormatters

Field Summary

Modifier and Type	Field and Description
private final Map<String, ParameterizedInvocationNameFormatter.PartialFormatter>	formattersByPlaceholder
private int	minimumPlaceholderLength

Constructor Summary

Access	Constructor and Description
private	PartialFormatters()

Method Summary

Modifier and Type	Method and Description
pack-priv ParameterizedInvocationNameFormatter.PartialFormatter	get(String placeholder)
pack-priv Set<String>	placeholders()
pack-priv void	put(String placeholder, ParameterizedInvocationNameFormatter.PartialFormatter formatter)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

formattersByPlaceholder	back to summary
private final Map<String, ParameterizedInvocationNameFormatter.PartialFormatter> formattersByPlaceholder

minimumPlaceholderLength	back to summary
private int minimumPlaceholderLength

Constructor Detail

PartialFormatters	back to summary
private PartialFormatters()

Method Detail

get	back to summary
pack-priv ParameterizedInvocationNameFormatter.PartialFormatter get(String placeholder)

placeholders	back to summary
pack-priv Set<String> placeholders()

put	back to summary
pack-priv void put(String placeholder, ParameterizedInvocationNameFormatter.PartialFormatter formatter)

org.junit.jupiter.params back to summary

private final Record ParameterizedInvocationNameFormatter.PlaceholderPosition

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.junit.jupiter.params.ParameterizedInvocationNameFormatter.PlaceholderPosition

Record Components

index:int
placeholder:String

Field Summary

Modifier and Type	Field and Description
private final int	index Record Component accessed by index().
private final String	placeholder Record Component accessed by placeholder().

Constructor Summary

Access	Constructor and Description
private	PlaceholderPosition(int index, String placeholder)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public int	index() Record Component getter of index.
public String	placeholder() Record Component getter of placeholder.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

index	back to summary
private final int index Record Component accessed by index().

placeholder	back to summary
private final String placeholder Record Component accessed by placeholder().

Constructor Detail

PlaceholderPosition	back to summary
private PlaceholderPosition(int index, String placeholder)

Method Detail

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

index	back to summary
public int index() Record Component getter of index.

placeholder	back to summary
public String placeholder() Record Component getter of placeholder.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.