univocity-parsers 2.9.1 · com.univocity.parsers.csv.CsvFormat

Modifier and Type	Field and Description
private Character	charToEscapeQuoteEscaping
private String	delimiter
private char	quote
private char	quoteEscape

Access	Constructor and Description
public	CsvFormat()

Method Summary

Modifier and Type	Method and Description
public final CsvFormat	clone() Overrides com.univocity.parsers.common.Format.clone. Creates and returns a copy of this object.
public final char	Returns: the character to escape the character used for escaping quotes defined getCharToEscapeQuoteEscaping() Returns the character used to escape the character used for escaping quotes defined by `getQuoteEscape()`.
protected TreeMap<String, Object>	getConfiguration() Implements abstract com.univocity.parsers.common.Format.getConfiguration.
public char	Returns: the field delimiter character getDelimiter() Returns the field delimiter character.
public String	Returns: the field delimiter as a `String`. getDelimiterString() Returns the field delimiter sequence.
public char	Returns: the quote character getQuote() Returns the character used for escaping values where the field delimiter is part of the value.
public char	Returns: the quote escape character getQuoteEscape() Returns the character used for escaping quotes inside an already quoted value.
public final boolean	Returns: true if the given character is used to escape the quote escape character, false otherwise isCharToEscapeQuoteEscaping(char the character to be verified ch) Identifies whether or not a given character is used to escape the character used for escaping quotes defined by `getQuoteEscape()`.
public boolean	Returns: true if the given character is the field delimiter character, false otherwise isDelimiter(char the character to be verified ch) Identifies whether or not a given character represents a field delimiter
public boolean	Returns: true if the given sequence is the field delimiter character sequence, false otherwise isDelimiter(String the character sequence to be verified sequence) Identifies whether or not a given character represents a field delimiter
public boolean	Returns: true if the given character is the character used for escaping values, false otherwise isQuote(char the character to be verified ch) Identifies whether or not a given character is used for escaping values where the field delimiter is part of the value
public boolean	Returns: true if the given character is the quote escape character, false otherwise isQuoteEscape(char the character to be verified ch) Identifies whether or not a given character is used for escaping quotes inside an already quoted value.
public final void	setCharToEscapeQuoteEscaping(char the character to escape the character used for escaping quotes defined charToEscapeQuoteEscaping) Defines the character used to escape the character used for escaping quotes defined by `getQuoteEscape()`.
public void	setDelimiter(char the field delimiter character delimiter) Defines the field delimiter character.
public void	setDelimiter(String the field delimiter sequence. delimiter) Defines the field delimiter as a sequence of characters.
public void	setQuote(char the quote character quote) Defines the character used for escaping values where the field delimiter is part of the value.
public void	setQuoteEscape(char the quote escape character quoteEscape) Defines the character used for escaping quotes inside an already quoted value.

Inherited from com.univocity.parsers.common.Format:: getComment getLineSeparator getLineSeparatorString getNormalizedNewline getSystemLineSeparator isComment isNewLine setComment setLineSeparator setLineSeparator setNormalizedNewline toString

charToEscapeQuoteEscaping	back to summary
private Character charToEscapeQuoteEscaping

delimiter	back to summary
private String delimiter

quote	back to summary
private char quote

quoteEscape	back to summary
private char quoteEscape

CsvFormat	back to summary
public CsvFormat()

Method Detail

clone back to summary

clone	back to summary
public final CsvFormat clone() Overrides com.univocity.parsers.common.Format.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:CsvFormat a clone of this instance. Annotations @Override

public final CsvFormat clone()

Overrides com.univocity.parsers.common.Format.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:CsvFormat

a clone of this instance.

Annotations

@Override

getCharToEscapeQuoteEscaping back to summary

getCharToEscapeQuoteEscaping	back to summary
public final char getCharToEscapeQuoteEscaping() Returns the character used to escape the character used for escaping quotes defined by `getQuoteEscape()`. For example, if the quote escape is set to '\', and the quoted value ends with: \", as in the following example: [ " a\\", b ] Then: If the character to escape the '\' is undefined, the record won't be parsed. The parser will read characters: [a],[\],["],[,],[ ],[b] and throw an error because it cannot find a closing quote If the character to escape the '\' is defined as '\', the record will be read with 2 values: [a\] and [b] Defaults to '\0' (undefined) Returns:char the character to escape the character used for escaping quotes defined

public final char getCharToEscapeQuoteEscaping()

Returns the character used to escape the character used for escaping quotes defined by getQuoteEscape(). For example, if the quote escape is set to '\', and the quoted value ends with: \", as in the following example:

[ " a\\", b ]

Then:

If the character to escape the '\' is undefined, the record won't be parsed. The parser will read characters: [a],[\],["],[,],[ ],[b] and throw an error because it cannot find a closing quote
If the character to escape the '\' is defined as '\', the record will be read with 2 values: [a\] and [b]

Defaults to '\0' (undefined)

Returns:char: the character to escape the character used for escaping quotes defined

getConfiguration	back to summary
protected TreeMap<String, Object> getConfiguration() Implements abstract com.univocity.parsers.common.Format.getConfiguration. Annotations @Override

getConfiguration

back to summary

protected TreeMap<String, Object> getConfiguration()

Implements abstract com.univocity.parsers.common.Format.getConfiguration.

Annotations

@Override

getDelimiter	back to summary
public char getDelimiter() Returns the field delimiter character. Defaults to ',' Returns:char the field delimiter character

getDelimiter

back to summary

public char getDelimiter()

Returns the field delimiter character. Defaults to ','

Returns:char: the field delimiter character

getDelimiterString back to summary

getDelimiterString	back to summary
public String getDelimiterString() Returns the field delimiter sequence. Returns:String the field delimiter as a `String`.

public String getDelimiterString()

Returns the field delimiter sequence.

Returns:String: the field delimiter as a String.

getQuote	back to summary
public char getQuote() Returns the character used for escaping values where the field delimiter is part of the value. Defaults to '"' Returns:char the quote character

getQuote

back to summary

public char getQuote()

Returns the character used for escaping values where the field delimiter is part of the value. Defaults to '"'

Returns:char: the quote character

getQuoteEscape	back to summary
public char getQuoteEscape() Returns the character used for escaping quotes inside an already quoted value. Defaults to '"' Returns:char the quote escape character

getQuoteEscape

back to summary

public char getQuoteEscape()

Returns the character used for escaping quotes inside an already quoted value. Defaults to '"'

Returns:char: the quote escape character

isCharToEscapeQuoteEscaping back to summary

isCharToEscapeQuoteEscaping	back to summary
public final boolean isCharToEscapeQuoteEscaping(char ch) Identifies whether or not a given character is used to escape the character used for escaping quotes defined by `getQuoteEscape()`. Parameters ch:char the character to be verified Returns:boolean true if the given character is used to escape the quote escape character, false otherwise

public final boolean isCharToEscapeQuoteEscaping(char ch)

Identifies whether or not a given character is used to escape the character used for escaping quotes defined by getQuoteEscape().

Parameters

ch:char: the character to be verified

Returns:boolean

true if the given character is used to escape the quote escape character, false otherwise

isDelimiter	back to summary
public boolean isDelimiter(char ch) Identifies whether or not a given character represents a field delimiter Parameters ch:char the character to be verified Returns:boolean true if the given character is the field delimiter character, false otherwise

isDelimiter

back to summary

public boolean isDelimiter(char ch)

Identifies whether or not a given character represents a field delimiter

Parameters

ch:char: the character to be verified

Returns:boolean

true if the given character is the field delimiter character, false otherwise

isDelimiter	back to summary
public boolean isDelimiter(String sequence) Identifies whether or not a given character represents a field delimiter Parameters sequence:String the character sequence to be verified Returns:boolean true if the given sequence is the field delimiter character sequence, false otherwise

isDelimiter

back to summary

public boolean isDelimiter(String sequence)

Identifies whether or not a given character represents a field delimiter

Parameters

sequence:String: the character sequence to be verified

Returns:boolean

true if the given sequence is the field delimiter character sequence, false otherwise

isQuote	back to summary
public boolean isQuote(char ch) Identifies whether or not a given character is used for escaping values where the field delimiter is part of the value Parameters ch:char the character to be verified Returns:boolean true if the given character is the character used for escaping values, false otherwise

isQuote

back to summary

public boolean isQuote(char ch)

Identifies whether or not a given character is used for escaping values where the field delimiter is part of the value

Parameters

ch:char: the character to be verified

Returns:boolean

true if the given character is the character used for escaping values, false otherwise

isQuoteEscape	back to summary
public boolean isQuoteEscape(char ch) Identifies whether or not a given character is used for escaping quotes inside an already quoted value. Parameters ch:char the character to be verified Returns:boolean true if the given character is the quote escape character, false otherwise

isQuoteEscape

back to summary

public boolean isQuoteEscape(char ch)

Identifies whether or not a given character is used for escaping quotes inside an already quoted value.

Parameters

ch:char: the character to be verified

Returns:boolean

true if the given character is the quote escape character, false otherwise

setCharToEscapeQuoteEscaping back to summary

setCharToEscapeQuoteEscaping	back to summary
public final void setCharToEscapeQuoteEscaping(char charToEscapeQuoteEscaping) Defines the character used to escape the character used for escaping quotes defined by `getQuoteEscape()`. For example, if the quote escape is set to '\', and the quoted value ends with: \", as in the following example: [ " a\\", b ] Then: If the character to escape the '\' is undefined, the record won't be parsed. The parser will read characters: [a],[\],["],[,],[ ],[b] and throw an error because it cannot find a closing quote If the character to escape the '\' is defined as '\', the record will be read with 2 values: [a\] and [b] Defaults to '\0' (undefined) Parameters charToEscapeQuoteEscaping:char the character to escape the character used for escaping quotes defined

public final void setCharToEscapeQuoteEscaping(char charToEscapeQuoteEscaping)

Defines the character used to escape the character used for escaping quotes defined by getQuoteEscape(). For example, if the quote escape is set to '\', and the quoted value ends with: \", as in the following example:

[ " a\\", b ]

Then:

If the character to escape the '\' is undefined, the record won't be parsed. The parser will read characters: [a],[\],["],[,],[ ],[b] and throw an error because it cannot find a closing quote
If the character to escape the '\' is defined as '\', the record will be read with 2 values: [a\] and [b]

Defaults to '\0' (undefined)

Parameters

charToEscapeQuoteEscaping:char: the character to escape the character used for escaping quotes defined

setDelimiter	back to summary
public void setDelimiter(char delimiter) Defines the field delimiter character. Defaults to ',' Parameters delimiter:char the field delimiter character

setDelimiter

back to summary

public void setDelimiter(char delimiter)

Defines the field delimiter character. Defaults to ','

Parameters

delimiter:char: the field delimiter character

setDelimiter	back to summary
public void setDelimiter(String delimiter) Defines the field delimiter as a sequence of characters. Defaults to ',' Parameters delimiter:String the field delimiter sequence.

setDelimiter

back to summary

public void setDelimiter(String delimiter)

Defines the field delimiter as a sequence of characters. Defaults to ','

Parameters

delimiter:String: the field delimiter sequence.

setQuote	back to summary
public void setQuote(char quote) Defines the character used for escaping values where the field delimiter is part of the value. Defaults to '"' Parameters quote:char the quote character

setQuote

back to summary

public void setQuote(char quote)

Defines the character used for escaping values where the field delimiter is part of the value. Defaults to '"'

Parameters

quote:char: the quote character

setQuoteEscape	back to summary
public void setQuoteEscape(char quoteEscape) Defines the character used for escaping quotes inside an already quoted value. Defaults to '"' Parameters quoteEscape:char the quote escape character

setQuoteEscape

back to summary

public void setQuoteEscape(char quoteEscape)

Defines the character used for escaping quotes inside an already quoted value. Defaults to '"'

Parameters

quoteEscape:char: the quote escape character

public Class CsvFormat

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail