Package com.univocity.parsers.tsv

Class TsvWriterSettings

    • Constructor Detail

      • TsvWriterSettings

        public TsvWriterSettings()

    • Method Detail

      • isLineJoiningEnabled

        public boolean isLineJoiningEnabled()
        Identifies whether values containing line endings should have the line separator written using the escape character (defined by TsvFormat.getEscapeChar() followed by the actual line separator character instead of other characters such as the standard letters 'n' and 'r' When line joining is disabled (the default), the TsvWriter will convert new line characters into sequences containing the escape character (typically '\') followed by characters 'n' or 'r'. No matter how many line separators the values written contain, the will be escaped and the entire output of a record will be written into a single line of text. For example, '\n' and '\r' characters will be written as: '\'+'n' and '\'+'r'. If line joining is enabled, the TsvWriter will convert line new line characters into sequences containing the escape character, followed by characters '\n', '\r' or both. A new line of text will be generated for each line separator found in the value to be written, "marking" the end of each line with the escape character to indicate the record continues on the next line. For example, '\n' and '\r' characters will be written as: '\'+'\n' and '\'+'\r'.
        Returns:
        true if line joining is enabled, otherwise false

      • setLineJoiningEnabled

        public void setLineJoiningEnabled​(boolean lineJoiningEnabled)
        Defines how the writer should handle the escaping of line separators. Values containing line endings should be escaped and the line separator characters can be written using the escape character (defined by TsvFormat.getEscapeChar() followed by the actual line separator character instead of other characters such as the standard letters 'n' and 'r' When line joining is disabled (the default), the TsvWriter will convert new line characters into sequences containing the escape character (typically '\') followed by characters 'n' or 'r'. No matter how many line separators the values written contain, the will be escaped and the entire output of a record will be written into a single line of text. For example, '\n' and '\r' characters will be written as: '\'+'n' and '\'+'r'. If line joining is enabled, the TsvWriter will convert line new line characters into sequences containing the escape character, followed by characters '\n', '\r' or both. A new line of text will be generated for each line separator found in the value to be written, "marking" the end of each line with the escape character to indicate the record continues on the next line. For example, '\n' and '\r' characters will be written as: '\'+'\n' and '\'+'\r'.
        Parameters:
        lineJoiningEnabled - a flag indicating whether or not to enable line joining.

      • clone

        public final TsvWriterSettings clone​(boolean clearInputSpecificSettings)
        Description copied from class: CommonSettings
        Clones this configuration object to reuse user-provided settings. Properties that are specific to a given input (such as header names and selection of fields) can be reset to their defaults if the clearInputSpecificSettings flag is set to true
        Overrides:
        clone in class CommonWriterSettings<TsvFormat>
        Parameters:
        clearInputSpecificSettings - flag indicating whether to clear settings that are likely to be associated with a given input.
        Returns:
        a copy of the configurations applied to the current instance.