Annotation Type CsvFileSource

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      char delimiter
      The column delimiter character to use when reading the CSV files.
      String delimiterString
      The column delimiter string to use when reading the CSV files.
      String emptyValue
      The empty value to use when reading the CSV files.
      String encoding
      The encoding to use when reading the CSV files; must be a valid charset.
      String[] files
      The CSV files to use as the sources of arguments; must not be empty unless resources() is non-empty.
      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.
      String[] nullValues
      A list of strings that should be interpreted as null references.
      int numLinesToSkip
      The number of lines to skip when reading the CSV files.
      String[] resources
      The CSV classpath resources to use as the sources of arguments; must not be empty unless files() is non-empty.
    • Element Detail

      • resources

        String[] resources
        The CSV classpath resources to use as the sources of arguments; must not be empty unless files() is non-empty.
        Default:
        {}
      • files

        String[] files
        The CSV files to use as the sources of arguments; must not be empty unless resources() is non-empty.
        Default:
        {}
      • encoding

        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

        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 character to use when reading the CSV files.

        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:
        '\u0000'
      • delimiterString

        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 with delimiter().

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

        Since:
        5.6
        Default:
        ""
      • numLinesToSkip

        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

        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:
        ""
      • nullValues

        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:
        {}
      • maxCharsPerColumn

        @API(status=EXPERIMENTAL,
             since="5.7")
        int maxCharsPerColumn
        The maximum characters of per CSV column allowed.

        Must be a positive number.

        Defaults to 4096.

        Since:
        5.7
        Default:
        4096