org.junit.jupiter.params.provider

Annotation Type CsvSource

@Target(value={ANNOTATION_TYPE,METHOD})
 @Retention(value=RUNTIME)
 @Documented
 @API(status=EXPERIMENTAL,
     since="5.0")
 @ArgumentsSource(value=CsvArgumentsProvider.class)
public @interface CsvSource

@CsvSource is an ArgumentsSource which reads comma-separated values (CSV) from one or more supplied CSV lines.

The supplied values will be provided as arguments to the annotated @ParameterizedTest method.

Since:

5.0

See Also:

CsvFileSource, ArgumentsSource, ParameterizedTest

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String[]	value The CSV lines to use as the source of arguments; must not be empty.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
char	delimiter The column delimiter character to use when reading the lines.
java.lang.String	delimiterString The column delimiter string to use when reading the lines.
java.lang.String	emptyValue The empty value to use when reading the lines.
java.lang.String[]	nullValues A list of strings that should be interpreted as null references.

Element Detail

value

public abstract java.lang.String[] value

The CSV lines to use as the source of arguments; must not be empty.

Each value corresponds to a line in a CSV file and will be split using the specified delimiter() or delimiterString(). Any line beginning with a # symbol will be interpreted as a comment and will be ignored.

delimiter

public abstract char delimiter

The column delimiter character to use when reading the lines.

This is an alternative to delimiterString() and cannot be used in conjunction with delimiterString().

Defaults implicitly to ',', if neither delimiter attribute is explicitly set.

Default:

0

delimiterString

@API(status=EXPERIMENTAL,
     since="5.6")
public abstract java.lang.String delimiterString

The column delimiter string to use when reading the lines.

This is an alternative to delimiter() and cannot be used in conjunction with delimiter().

Defaults implicitly to ",", if neither delimiter attribute is explicitly set.

Since:

5.6

Default:

""

emptyValue

@API(status=EXPERIMENTAL,
     since="5.5")
public abstract java.lang.String emptyValue

The empty value to use when reading the lines.

This value replaces quoted empty strings read from the input.

Defaults to "".

Since:

5.5

Default:

""

nullValues

@API(status=EXPERIMENTAL,
     since="5.6")
public abstract java.lang.String[] nullValues

A list of strings that should be interpreted as null references.

For example, you may wish for certain values such as "N/A" or "NIL" to be converted to null references.

Please note that unquoted empty values will always be converted to null references regardless of the value of this nullValues attribute; whereas, a quoted empty string will be treated as an emptyValue().

Defaults to {}.

Since:

5.6

Default:

{}