Class TsvFormat

java.lang.Object
com.univocity.parsers.common.Format
com.univocity.parsers.tsv.TsvFormat
All Implemented Interfaces:
Cloneable

public class TsvFormat extends Format
The TSV format configuration, for tab-separated inputs. It offers the options in the default configuration in Format, as well as the escapeChar character for escaping \t, \n, \r and \ in TSV values. Delimiters are defined as tab characters '\t'
See Also:
  • Field Details

    • escapeChar

      private char escapeChar
    • escapedTabChar

      private char escapedTabChar
  • Constructor Details

    • TsvFormat

      public TsvFormat()
  • Method Details

    • setEscapeChar

      public void setEscapeChar(char escapeChar)
      Defines the character used for escaping special characters in TSV inputs: \t, \n, \r and \ . Defaults to '\\'
      Parameters:
      escapeChar - the escape character
    • getEscapeChar

      public char getEscapeChar()
      Returns the character used for escaping special characters in TSV inputs: \t, \n, \r and \
      Returns:
      the escape character.
    • getEscapedTabChar

      public char getEscapedTabChar()
      Returns the character that should be used to represent an escaped tab, i.e. the character before the defined getEscapeChar(). For example, if getEscapeChar() == '\\' and == 'X', the sequence '\X' will identify a tab. Defaults to 't'.
      Returns:
      the character following the getEscapeChar() that represents an escaped tab.
    • setEscapedTabChar

      public void setEscapedTabChar(char escapedTabChar)
      Defines the character that should be used to represent an escaped tab, i.e. the character before the defined getEscapeChar(). For example, if getEscapeChar() == '\\' and == 'X', the sequence '\X' will identify a tab. Defaults to 't'.
      Parameters:
      escapedTabChar - the character following the getEscapeChar() that represents an escaped tab.
    • isEscapeChar

      public boolean isEscapeChar(char ch)
      Identifies whether or not a given character is used for escaping special characters in TSV (\t, \n, \r and \).
      Parameters:
      ch - the character to be verified
      Returns:
      true if the given character is escape character, false otherwise
    • getConfiguration

      protected TreeMap<String,Object> getConfiguration()
      Specified by:
      getConfiguration in class Format
    • clone

      public final TsvFormat clone()
      Overrides:
      clone in class Format