Package org.junit.jupiter.params.provider

Annotation Type CsvFileSource

  • @Target({ANNOTATION_TYPE,METHOD})
@Retention(RUNTIME)
@Documented
@API(status=EXPERIMENTAL,
     since="5.0")
@ArgumentsSource(org.junit.jupiter.params.provider.CsvFileArgumentsProvider.class)
public @interface CsvFileSource
    @CsvFileSource is an ArgumentsSource which is used to load comma-separated value (CSV) files from one or more classpath resources.

    The lines of these CSV files will be provided as arguments to the annotated @ParameterizedTest method.

    Since:
    5.0
    See Also:
    CsvSource, ArgumentsSource, ParameterizedTest

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String[] resources
      The CSV classpath resources to use as the sources of arguments; must not be empty.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      char delimiter
      The column delimiter 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 lineSeparator
      The line separator to use when reading the CSV files; must consist of 1 or 2 characters.
      int numLinesToSkip
      The number of lines to skip when reading the CSV files.

    • Element Detail

      • resources

        java.lang.String[] resources
        The CSV classpath resources to use as the sources of arguments; must not be empty.

      • encoding

        java.lang.String encoding
        The encoding to use when reading the CSV files; must be a valid charset.

        Defaults to "UTF-8".

        See Also:
        StandardCharsets
        Default:
        "UTF-8"

      • lineSeparator

        java.lang.String lineSeparator
        The line separator to use when reading the CSV files; must consist of 1 or 2 characters.

        Defaults to "\n".

        Default:
        "\n"

      • delimiter

        char delimiter
        The column delimiter to use when reading the CSV files.

        Defaults to ",".

        Default:
        ','

      • numLinesToSkip

        @API(status=EXPERIMENTAL,
     since="5.1")
int numLinesToSkip
        The number of lines to skip when reading the CSV files.

        Typically used to skip header lines.

        Defaults to 0.

        Since:
        5.1
        Default:
        0

      • emptyValue

        @API(status=EXPERIMENTAL,
     since="5.5")
java.lang.String emptyValue
        The empty value to use when reading the CSV files.

        This value replaces quoted empty strings read from the input.

        Defaults to "".

        Since:
        5.5
        Default:
        ""