com.univocity.parsers.tsv

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'

Author:

Univocity Software Pty Ltd - parsers@univocity.com

See Also:

Format

Constructor Summary

Constructors

Constructor and Description
TsvFormat()

Method Summary

Modifier and Type	Method and Description
TsvFormat	clone()
protected TreeMap<String,Object>	getConfiguration()
char	getEscapeChar() Returns the character used for escaping special characters in TSV inputs: \t, \n, \r and \
char	getEscapedTabChar() Returns the character that should be used to represent an escaped tab, i.e.
boolean	isEscapeChar(char ch) Identifies whether or not a given character is used for escaping special characters in TSV (\t, \n, \r and \).
TsvFormat	setComment(char comment) Defines the character that represents a line comment when found in the beginning of a line of text.
TsvFormat	setEscapeChar(char escapeChar) Defines the character used for escaping special characters in TSV inputs: \t, \n, \r and \ .
TsvFormat	setEscapedTabChar(char escapedTabChar) Defines the character that should be used to represent an escaped tab, i.e.
TsvFormat	setLineSeparator(char[] lineSeparator) Defines the line separator sequence that should be used for parsing and writing.
TsvFormat	setLineSeparator(String lineSeparator) Defines the line separator sequence that should be used for parsing and writing.
TsvFormat	setNormalizedNewline(char normalizedNewline) Sets the normalized newline character, which is automatically replaced by Format.getLineSeparator() when reading/writing

Methods inherited from class com.univocity.parsers.common.Format

getComment, getLineSeparator, getLineSeparatorString, getNormalizedNewline, getSystemLineSeparator, isComment, isNewLine, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TsvFormat

public TsvFormat()

Method Detail

setEscapeChar

public TsvFormat 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

Returns:

this TsvFormat instance

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 TsvFormat 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.

Returns:

this TsvFormat instance

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

setLineSeparator

public TsvFormat setLineSeparator(String lineSeparator)

Defines the line separator sequence that should be used for parsing and writing.

Overrides:

setLineSeparator in class Format

Parameters:

lineSeparator - a sequence of 1 to 2 characters that identifies the end of a line

Returns:

this TsvFormat instance

setLineSeparator

public TsvFormat setLineSeparator(char[] lineSeparator)

Defines the line separator sequence that should be used for parsing and writing.

Overrides:

setLineSeparator in class Format

Parameters:

lineSeparator - a sequence of 1 to 2 characters that identifies the end of a line

Returns:

this TsvFormat instance

setNormalizedNewline

public TsvFormat setNormalizedNewline(char normalizedNewline)

Sets the normalized newline character, which is automatically replaced by Format.getLineSeparator() when reading/writing

Overrides:

setNormalizedNewline in class Format

Parameters:

normalizedNewline - a single character used to represent a line separator.

Returns:

this TsvFormat instance

setComment

public TsvFormat setComment(char comment)

Defines the character that represents a line comment when found in the beginning of a line of text. Defaults to '#'

Use '\0' to disable comment skipping.

Overrides:

setComment in class Format

Parameters:

comment - the comment character

Returns:

this TsvFormat instance

getConfiguration

protected TreeMap<String,Object> getConfiguration()

Specified by:

getConfiguration in class Format

clone

public final TsvFormat clone()

Overrides:

clone in class Format