Annotation Type CsvFileSource
-
@Target({ANNOTATION_TYPE,METHOD}) @Retention(RUNTIME) @Documented @API(status=STABLE, since="5.7") @ArgumentsSource(CsvFileArgumentsProvider.class) public @interface CsvFileSource
@CsvFileSource
is anArgumentsSource
which is used to load comma-separated value (CSV) files from one or more classpathresources
orfiles()
.The lines of these CSV files will be provided as arguments to the annotated
@ParameterizedTest
method. Any line beginning with a#
symbol will be interpreted as a comment and will be ignored.- Since:
- 5.0
- See Also:
CsvSource
,ArgumentsSource
,ParameterizedTest
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description char
delimiter
The column delimiter character to use when reading the CSV files.java.lang.String
delimiterString
The column delimiter string to use when reading the CSV files.java.lang.String
emptyValue
The empty value to use when reading the CSV files.java.lang.String
encoding
The encoding to use when reading the CSV files; must be a valid charset.java.lang.String[]
files
The CSV files to use as the sources of arguments; must not be empty unlessresources()
is non-empty.java.lang.String
lineSeparator
The line separator to use when reading the CSV files; must consist of 1 or 2 characters.int
maxCharsPerColumn
The maximum characters of per CSV column allowed.java.lang.String[]
nullValues
A list of strings that should be interpreted asnull
references.int
numLinesToSkip
The number of lines to skip when reading the CSV files.java.lang.String[]
resources
The CSV classpath resources to use as the sources of arguments; must not be empty unlessfiles()
is non-empty.
-
-
-
Element Detail
-
resources
java.lang.String[] resources
The CSV classpath resources to use as the sources of arguments; must not be empty unlessfiles()
is non-empty.- Default:
- {}
-
-
-
files
java.lang.String[] files
The CSV files to use as the sources of arguments; must not be empty unlessresources()
is non-empty.- Default:
- {}
-
-
-
delimiter
char delimiter
The column delimiter character to use when reading the CSV files.This is an alternative to
delimiterString()
and cannot be used in conjunction withdelimiterString()
.Defaults implicitly to
','
, if neither delimiter attribute is explicitly set.- Default:
- '\u0000'
-
-
-
delimiterString
java.lang.String delimiterString
The column delimiter string to use when reading the CSV files.This is an alternative to
delimiter()
and cannot be used in conjunction withdelimiter()
.Defaults implicitly to
","
, if neither delimiter attribute is explicitly set.- Since:
- 5.6
- Default:
- ""
-
-
-
nullValues
java.lang.String[] nullValues
A list of strings that should be interpreted asnull
references.For example, you may wish for certain values such as
"N/A"
or"NIL"
to be converted tonull
references.Please note that unquoted empty values will always be converted to
null
references regardless of the value of thisnullValues
attribute; whereas, a quoted empty string will be treated as anemptyValue()
.Defaults to
{}
.- Since:
- 5.6
- Default:
- {}
-
-