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

Modifier and Type	Field and Description
private boolean	delimiterDetectionEnabled
private char[]	delimitersForDetection
private String	emptyValue
private boolean	escapeUnquotedValues
private int	formatDetectorRowSampleCount
private boolean	ignoreLeadingWhitespacesInQuotes
private boolean	ignoreTrailingWhitespacesInQuotes
private boolean	keepEscapeSequences
private boolean	keepQuotes
private boolean	normalizeLineEndingsWithinQuotes
private boolean	parseUnescapedQuotes
private boolean	parseUnescapedQuotesUntilDelimiter
private boolean	quoteDetectionEnabled
private UnescapedQuoteHandling	unescapedQuoteHandling

Access	Constructor and Description
public	CsvParserSettings()

Method Summary

Modifier and Type	Method and Description
protected void	addConfiguration(Map<String, Object> out) Overrides com.univocity.parsers.common.CommonParserSettings.addConfiguration.
public final CsvParserSettings	clone() Overrides com.univocity.parsers.common.CommonParserSettings.clone. Clones this configuration object.
public final CsvParserSettings	clone(boolean flag indicating whether to clear settings that are likely to be associated with a given input. clearInputSpecificSettings) Overrides com.univocity.parsers.common.CommonParserSettings.clone. Clones this configuration object to reuse user-provided settings.
protected CsvFormat	Returns: and instance of CsvFormat configured to handle CSV inputs compliant to the RFC4180 standard. createDefaultFormat() Implements abstract com.univocity.parsers.common.CommonSettings.createDefaultFormat. Returns the default CsvFormat configured to handle CSV inputs compliant to the RFC4180 standard.
public final void	detectFormatAutomatically() Convenience method to turn on all format detection features in a single method call, namely: `setDelimiterDetectionEnabled(boolean, char[])` `setQuoteDetectionEnabled(boolean)` `setLineSeparatorDetectionEnabled(boolean)`
public final void	detectFormatAutomatically(char... possible delimiters for detection, in order of priority. delimitersForDetection) Convenience method to turn on all format detection features in a single method call, namely: `setDelimiterDetectionEnabled(boolean, char[])` `setQuoteDetectionEnabled(boolean)` `setLineSeparatorDetectionEnabled(boolean)`
public final char[]	Returns: the possible delimiter characters, in order of priority. getDelimitersForDetection() Returns the sequence of possible delimiters for detection when `isDelimiterDetectionEnabled()` evaluates to `true`, in order of priority.
public String	Returns: the String representation of an empty value getEmptyValue() Returns the String representation of an empty value (defaults to null) When reading, if the parser does not read any character from the input, and the input is within quotes, the empty is used instead of an empty string
public int	Returns: the number of sample rows used in the CSV format auto-detection process getFormatDetectorRowSampleCount() Returns the number of sample rows used in the CSV format auto-detection process (defaults to 20)
public boolean	Returns: true if leading whitespaces from quoted values should be skipped, false otherwise getIgnoreLeadingWhitespacesInQuotes() Returns whether or not leading whitespaces from quoted values should be skipped (defaults to false) Note: if `keepQuotes` evaluates to `true`, values won't be trimmed.
public boolean	Returns: true if trailing whitespaces from quoted values should be skipped, false otherwise getIgnoreTrailingWhitespacesInQuotes() Returns whether or not trailing whitespaces from within quoted values should be skipped (defaults to false) Note: if `keepQuotes` evaluates to `true`, values won't be trimmed.
public boolean	Returns: a flag indicating whether enclosing quotes should be maintained when parsing quoted values. getKeepQuotes() Flag indicating whether the parser should keep enclosing quote characters in the values parsed from the input.
public UnescapedQuoteHandling	Returns: the handling method to be used when unescaped quotes are found in the input, or `null` if not set. getUnescapedQuoteHandling() Returns the method of handling values with unescaped quotes.
public final boolean	Returns: a flag indicating whether the parser should analyze the input to discover the column delimiter character. isDelimiterDetectionEnabled() Returns a flag indicating whether the parser should analyze the input to discover the column delimiter character.
public boolean	Returns: true if escape sequences should be processed in unquoted values, otherwise false isEscapeUnquotedValues() Indicates whether escape sequences should be processed in unquoted values.
public final boolean	Returns: a flag indicating whether escape sequences should be kept (and not replaced) by the parser. isKeepEscapeSequences() Indicates whether the parser should keep any escape sequences if they are present in the input (i.e. a quote escape sequence such as two double quotes `""` won't be replaced by a single double quote `"`).
public boolean	Returns: `true` if line separators in quoted values will be normalized, `false` otherwise isNormalizeLineEndingsWithinQuotes() Flag indicating whether the parser should replace line separators, specified in `Format#getLineSeparator()` by the normalized line separator character specified in `Format#getNormalizedNewline()`, even on quoted values.
public boolean	Returns: a flag indicating whether or not the CSV parser should accept unescaped quotes inside quoted values. isParseUnescapedQuotes() Deprecated use `getUnescapedQuoteHandling()` instead. Indicates whether the CSV parser should accept unescaped quotes inside quoted values and parse them normally.
public boolean	Returns: a flag indicating that the parser should stop accumulating values when a field delimiter character is found when parsing unquoted and unescaped values. isParseUnescapedQuotesUntilDelimiter() Deprecated use `getUnescapedQuoteHandling()` instead. When parsing unescaped quotes, indicates the parser should stop accumulating characters and consider the value parsed when a delimiter is found.
public final boolean	Returns: a flag indicating whether the parser should analyze the input to discover the quote character. The quote escape will also be detected as part of this process. isQuoteDetectionEnabled() Returns a flag indicating whether the parser should analyze the input to discover the quote character.
protected CharAppender	Returns: an instance of CharAppender with the configured limit of maximum characters per column and the default value used to represent an empty value (when the String parsed from the input, within quotes, is empty) newCharAppender() Overrides com.univocity.parsers.common.CommonParserSettings.newCharAppender. Returns an instance of CharAppender with the configured limit of maximum characters per column and the default value used to represent an empty value (when the String parsed from the input, within quotes, is empty) This overrides the parent's version because the CSV parser does not rely on the appender to identify null values, but on the other hand, the appender is required to identify empty values.
public final void	setDelimiterDetectionEnabled(boolean the flag to enable/disable discovery of the column delimiter character. to `true`, in order of priority. separatorDetectionEnabled) Configures the parser to analyze the input before parsing to discover the column delimiter character.
public final void	setDelimiterDetectionEnabled(boolean the flag to enable/disable discovery of the column delimiter character. separatorDetectionEnabled, char... possible delimiters for detection when `isDelimiterDetectionEnabled()` evaluates to `true`, in order of priority. delimitersForDetection) Configures the parser to analyze the input before parsing to discover the column delimiter character.
public void	setEmptyValue(String the String representation of an empty value emptyValue) Sets the String representation of an empty value (defaults to null) When reading, if the parser does not read any character from the input, and the input is within quotes, the empty is used instead of an empty string
public void	setEscapeUnquotedValues(boolean a flag indicating whether escape sequences should be processed in unquoted values escapeUnquotedValues) Configures the parser to process escape sequences in unquoted values.
public void	setFormatDetectorRowSampleCount(int the number of sample rows used in the CSV format auto-detection process formatDetectorRowSampleCount) Updates the number of sample rows used in the CSV format auto-detection process (defaults to 20)
public void	setIgnoreLeadingWhitespacesInQuotes(boolean whether leading whitespaces from quoted values should be skipped ignoreLeadingWhitespacesInQuotes) Defines whether or not leading whitespaces from quoted values should be skipped (defaults to false) Note: if `keepQuotes` evaluates to `true`, values won't be trimmed.
public void	setIgnoreTrailingWhitespacesInQuotes(boolean whether trailing whitespaces from quoted values should be skipped ignoreTrailingWhitespacesInQuotes) Defines whether or not trailing whitespaces from quoted values should be skipped (defaults to false) Note: if `keepQuotes` evaluates to `true`, values won't be trimmed.
public final void	setKeepEscapeSequences(boolean the flag indicating whether escape sequences should be kept (and not replaced) by the parser. keepEscapeSequences) Configures the parser to keep any escape sequences if they are present in the input (i.e. a quote escape sequence such as 2 double quotes `""` won't be replaced by a single double quote `"`).
public void	setKeepQuotes(boolean flag indicating whether enclosing quotes should be maintained when parsing quoted values. keepQuotes) Configures the parser to keep enclosing quote characters in the values parsed from the input.
public void	setNormalizeLineEndingsWithinQuotes(boolean flag indicating whether line separators in quoted values should be replaced by the the character specified in `Format#getNormalizedNewline()` . normalizeLineEndingsWithinQuotes) Configures the parser to replace line separators, specified in `Format#getLineSeparator()` by the normalized line separator character specified in `Format#getNormalizedNewline()`, even on quoted values.
public void	setParseUnescapedQuotes(boolean indicates whether or not the CSV parser should accept unescaped quotes inside quoted values. parseUnescapedQuotes) Deprecated use `setUnescapedQuoteHandling(UnescapedQuoteHandling)` instead. Configures how to handle unescaped quotes inside quoted values.
public void	setParseUnescapedQuotesUntilDelimiter(boolean a flag indicating that the parser should stop accumulating values when a field delimiter character is found when parsing unquoted and unescaped values. parseUnescapedQuotesUntilDelimiter) Deprecated use `setUnescapedQuoteHandling(UnescapedQuoteHandling)` instead. Configures the parser to process values with unescaped quotes, and stop accumulating characters and consider the value parsed when a delimiter is found.
public final void	setQuoteDetectionEnabled(boolean the flag to enable/disable discovery of the quote character. The quote escape will also be detected as part of this process. quoteDetectionEnabled) Configures the parser to analyze the input before parsing to discover the quote character.
public void	setUnescapedQuoteHandling(UnescapedQuoteHandling the handling method to be used when unescaped quotes are found in the input. unescapedQuoteHandling) Configures the handling of values with unescaped quotes.
public final void	trimQuotedValues(boolean a flag indicating whether whitespaces around values extracted from a quoted field should be removed trim) Configures the parser to trim any whitespaces around values extracted from within quotes.

delimiterDetectionEnabled	back to summary
private boolean delimiterDetectionEnabled

delimitersForDetection	back to summary
private char[] delimitersForDetection

emptyValue	back to summary
private String emptyValue

escapeUnquotedValues	back to summary
private boolean escapeUnquotedValues

formatDetectorRowSampleCount	back to summary
private int formatDetectorRowSampleCount

ignoreLeadingWhitespacesInQuotes	back to summary
private boolean ignoreLeadingWhitespacesInQuotes

ignoreTrailingWhitespacesInQuotes	back to summary
private boolean ignoreTrailingWhitespacesInQuotes

keepEscapeSequences	back to summary
private boolean keepEscapeSequences

keepQuotes	back to summary
private boolean keepQuotes

normalizeLineEndingsWithinQuotes	back to summary
private boolean normalizeLineEndingsWithinQuotes

parseUnescapedQuotes	back to summary
private boolean parseUnescapedQuotes

parseUnescapedQuotesUntilDelimiter	back to summary
private boolean parseUnescapedQuotesUntilDelimiter

quoteDetectionEnabled	back to summary
private boolean quoteDetectionEnabled

unescapedQuoteHandling	back to summary
private UnescapedQuoteHandling unescapedQuoteHandling

CsvParserSettings	back to summary
public CsvParserSettings()

Method Detail

addConfiguration	back to summary
protected void addConfiguration(Map<String, Object> out) Overrides com.univocity.parsers.common.CommonParserSettings.addConfiguration. Annotations @Override

addConfiguration

back to summary

protected void addConfiguration(Map<String, Object> out)

Overrides com.univocity.parsers.common.CommonParserSettings.addConfiguration.

Annotations

@Override

clone back to summary

clone	back to summary
public final CsvParserSettings clone() Overrides com.univocity.parsers.common.CommonParserSettings.clone. Doc from com.univocity.parsers.common.CommonSettings.clone. Clones this configuration object. Use alternative `clone(boolean)` method to reset properties that are specific to a given input, such as header names and selection of fields. Returns:CsvParserSettings a copy of all configurations applied to the current instance. Annotations @Override

public final CsvParserSettings clone()

Overrides com.univocity.parsers.common.CommonParserSettings.clone.

Doc from com.univocity.parsers.common.CommonSettings.clone.

Clones this configuration object. Use alternative clone(boolean) method to reset properties that are specific to a given input, such as header names and selection of fields.

Returns:CsvParserSettings

a copy of all configurations applied to the current instance.

Annotations

@Override

clone back to summary

clone	back to summary
public final CsvParserSettings clone(boolean clearInputSpecificSettings) Overrides com.univocity.parsers.common.CommonParserSettings.clone. Doc from com.univocity.parsers.common.CommonSettings.clone. 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` Parameters clearInputSpecificSettings:boolean flag indicating whether to clear settings that are likely to be associated with a given input. Returns:CsvParserSettings a copy of the configurations applied to the current instance. Annotations @Override

public final CsvParserSettings clone(boolean clearInputSpecificSettings)

Overrides com.univocity.parsers.common.CommonParserSettings.clone.

Doc from com.univocity.parsers.common.CommonSettings.clone.

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

Parameters

clearInputSpecificSettings:boolean: flag indicating whether to clear settings that are likely to be associated with a given input.

Returns:CsvParserSettings

a copy of the configurations applied to the current instance.

Annotations

@Override

createDefaultFormat	back to summary
protected CsvFormat createDefaultFormat() Implements abstract com.univocity.parsers.common.CommonSettings.createDefaultFormat. Returns the default CsvFormat configured to handle CSV inputs compliant to the RFC4180 standard. Returns:CsvFormat and instance of CsvFormat configured to handle CSV inputs compliant to the RFC4180 standard. Annotations @Override

createDefaultFormat

back to summary

protected CsvFormat createDefaultFormat()

Implements abstract com.univocity.parsers.common.CommonSettings.createDefaultFormat.

Returns the default CsvFormat configured to handle CSV inputs compliant to the RFC4180 standard.

Returns:CsvFormat

and instance of CsvFormat configured to handle CSV inputs compliant to the RFC4180 standard.

Annotations

@Override

detectFormatAutomatically back to summary

detectFormatAutomatically	back to summary
public final void detectFormatAutomatically() Convenience method to turn on all format detection features in a single method call, namely: `setDelimiterDetectionEnabled(boolean, char[])` `setQuoteDetectionEnabled(boolean)` `setLineSeparatorDetectionEnabled(boolean)`

public final void detectFormatAutomatically()

Convenience method to turn on all format detection features in a single method call, namely:

detectFormatAutomatically back to summary

detectFormatAutomatically	back to summary
public final void detectFormatAutomatically(char... delimitersForDetection) Convenience method to turn on all format detection features in a single method call, namely: `setDelimiterDetectionEnabled(boolean, char[])` `setQuoteDetectionEnabled(boolean)` `setLineSeparatorDetectionEnabled(boolean)` Parameters delimitersForDetection:char[] possible delimiters for detection, in order of priority.

public final void detectFormatAutomatically(char... delimitersForDetection)

Convenience method to turn on all format detection features in a single method call, namely:

Parameters

delimitersForDetection:char[]: possible delimiters for detection, in order of priority.

getDelimitersForDetection back to summary

getDelimitersForDetection	back to summary
public final char[] getDelimitersForDetection() Returns the sequence of possible delimiters for detection when `isDelimiterDetectionEnabled()` evaluates to `true`, in order of priority. Returns:char[] the possible delimiter characters, in order of priority.

public final char[] getDelimitersForDetection()

Returns the sequence of possible delimiters for detection when isDelimiterDetectionEnabled() evaluates to true, in order of priority.

Returns:char[]: the possible delimiter characters, in order of priority.

getEmptyValue	back to summary
public String getEmptyValue() Returns the String representation of an empty value (defaults to null) When reading, if the parser does not read any character from the input, and the input is within quotes, the empty is used instead of an empty string Returns:String the String representation of an empty value

getEmptyValue

back to summary

public String getEmptyValue()

Returns the String representation of an empty value (defaults to null)

When reading, if the parser does not read any character from the input, and the input is within quotes, the empty is used instead of an empty string

Returns:String: the String representation of an empty value

getFormatDetectorRowSampleCount	back to summary
public int getFormatDetectorRowSampleCount() Returns the number of sample rows used in the CSV format auto-detection process (defaults to 20) Returns:int the number of sample rows used in the CSV format auto-detection process

getFormatDetectorRowSampleCount

back to summary

public int getFormatDetectorRowSampleCount()

Returns the number of sample rows used in the CSV format auto-detection process (defaults to 20)

Returns:int: the number of sample rows used in the CSV format auto-detection process

getIgnoreLeadingWhitespacesInQuotes back to summary

getIgnoreLeadingWhitespacesInQuotes	back to summary
public boolean getIgnoreLeadingWhitespacesInQuotes() Returns whether or not leading whitespaces from quoted values should be skipped (defaults to false) Note: if `keepQuotes` evaluates to `true`, values won't be trimmed. Returns:boolean true if leading whitespaces from quoted values should be skipped, false otherwise

public boolean getIgnoreLeadingWhitespacesInQuotes()

Returns whether or not leading whitespaces from quoted values should be skipped (defaults to false) Note: if keepQuotes evaluates to true, values won't be trimmed.

Returns:boolean: true if leading whitespaces from quoted values should be skipped, false otherwise

getIgnoreTrailingWhitespacesInQuotes back to summary

getIgnoreTrailingWhitespacesInQuotes	back to summary
public boolean getIgnoreTrailingWhitespacesInQuotes() Returns whether or not trailing whitespaces from within quoted values should be skipped (defaults to false) Note: if `keepQuotes` evaluates to `true`, values won't be trimmed. Returns:boolean true if trailing whitespaces from quoted values should be skipped, false otherwise

public boolean getIgnoreTrailingWhitespacesInQuotes()

Returns whether or not trailing whitespaces from within quoted values should be skipped (defaults to false) Note: if keepQuotes evaluates to true, values won't be trimmed.

Returns:boolean: true if trailing whitespaces from quoted values should be skipped, false otherwise

getKeepQuotes back to summary

getKeepQuotes	back to summary
public boolean getKeepQuotes() Flag indicating whether the parser should keep enclosing quote characters in the values parsed from the input. Defaults to `false` Returns:boolean a flag indicating whether enclosing quotes should be maintained when parsing quoted values.

public boolean getKeepQuotes()

Flag indicating whether the parser should keep enclosing quote characters in the values parsed from the input.

Defaults to false

Returns:boolean: a flag indicating whether enclosing quotes should be maintained when parsing quoted values.

getUnescapedQuoteHandling back to summary

getUnescapedQuoteHandling	back to summary
public UnescapedQuoteHandling getUnescapedQuoteHandling() Returns the method of handling values with unescaped quotes. Defaults to `null`, for backward compatibility with `isParseUnescapedQuotes()` and `isParseUnescapedQuotesUntilDelimiter()` If set to a non-null value, this setting will override the configuration of `isParseUnescapedQuotes()` and `isParseUnescapedQuotesUntilDelimiter()`. Returns:UnescapedQuoteHandling the handling method to be used when unescaped quotes are found in the input, or `null` if not set.

public UnescapedQuoteHandling getUnescapedQuoteHandling()

Returns the method of handling values with unescaped quotes. Defaults to null, for backward compatibility with isParseUnescapedQuotes() and isParseUnescapedQuotesUntilDelimiter() If set to a non-null value, this setting will override the configuration of isParseUnescapedQuotes() and isParseUnescapedQuotesUntilDelimiter().

Returns:UnescapedQuoteHandling: the handling method to be used when unescaped quotes are found in the input, or null if not set.

isDelimiterDetectionEnabled back to summary

isDelimiterDetectionEnabled	back to summary
public final boolean isDelimiterDetectionEnabled() Returns a flag indicating whether the parser should analyze the input to discover the column delimiter character. Note that the detection process is not guaranteed to discover the correct column delimiter. In this case the delimiter provided by `CsvFormat#getDelimiter()` will be used Returns:boolean a flag indicating whether the parser should analyze the input to discover the column delimiter character.

public final boolean isDelimiterDetectionEnabled()

Returns a flag indicating whether the parser should analyze the input to discover the column delimiter character.

Note that the detection process is not guaranteed to discover the correct column delimiter. In this case the delimiter provided by CsvFormat#getDelimiter() will be used

Returns:boolean: a flag indicating whether the parser should analyze the input to discover the column delimiter character.

isEscapeUnquotedValues back to summary

isEscapeUnquotedValues	back to summary
public boolean isEscapeUnquotedValues() Indicates whether escape sequences should be processed in unquoted values. Defaults to `false`. By default, this is disabled and if the input is `A""B,C`, the resulting value will be `[A""B] and [C]` (i.e. the content is read as-is). However, if the parser is configured to process escape sequences in unquoted values, the result will be `[A"B] and [C]` Returns:boolean true if escape sequences should be processed in unquoted values, otherwise false

public boolean isEscapeUnquotedValues()

Indicates whether escape sequences should be processed in unquoted values. Defaults to false.

By default, this is disabled and if the input is A""B,C, the resulting value will be [A""B] and [C] (i.e. the content is read as-is). However, if the parser is configured to process escape sequences in unquoted values, the result will be [A"B] and [C]

Returns:boolean: true if escape sequences should be processed in unquoted values, otherwise false

isKeepEscapeSequences back to summary

isKeepEscapeSequences	back to summary
public final boolean isKeepEscapeSequences() Indicates whether the parser should keep any escape sequences if they are present in the input (i.e. a quote escape sequence such as two double quotes `""` won't be replaced by a single double quote `"`). This is disabled by default Returns:boolean a flag indicating whether escape sequences should be kept (and not replaced) by the parser.

public final boolean isKeepEscapeSequences()

Indicates whether the parser should keep any escape sequences if they are present in the input (i.e. a quote escape sequence such as two double quotes "" won't be replaced by a single double quote ").

This is disabled by default

Returns:boolean: a flag indicating whether escape sequences should be kept (and not replaced) by the parser.

isNormalizeLineEndingsWithinQuotes back to summary

isNormalizeLineEndingsWithinQuotes	back to summary
public boolean isNormalizeLineEndingsWithinQuotes() Flag indicating whether the parser should replace line separators, specified in `Format#getLineSeparator()` by the normalized line separator character specified in `Format#getNormalizedNewline()`, even on quoted values. This is enabled by default and is used to ensure data be read on any platform without introducing unwanted blank lines. For example, consider the quoted value `"Line1 \r\n Line2"`. If this is parsed using `"\r\n"` as the line separator sequence, and the normalized new line is set to `'\n'` (the default), the output will be: `[Line1 \n Line2]` However, if the value is meant to be kept untouched, and the original line separator should be maintained, set the `normalizeLineEndingsWithinQuotes` to `false`. This will make the parser read the value as-is, producing: `[Line1 \r\n Line2]` Returns:boolean `true` if line separators in quoted values will be normalized, `false` otherwise

public boolean isNormalizeLineEndingsWithinQuotes()

Flag indicating whether the parser should replace line separators, specified in Format#getLineSeparator() by the normalized line separator character specified in Format#getNormalizedNewline(), even on quoted values. This is enabled by default and is used to ensure data be read on any platform without introducing unwanted blank lines. For example, consider the quoted value "Line1 \r\n Line2". If this is parsed using "\r\n" as the line separator sequence, and the normalized new line is set to '\n' (the default), the output will be: [Line1 \n Line2] However, if the value is meant to be kept untouched, and the original line separator should be maintained, set the normalizeLineEndingsWithinQuotes to false. This will make the parser read the value as-is, producing: [Line1 \r\n Line2]

Returns:boolean: true if line separators in quoted values will be normalized, false otherwise

isParseUnescapedQuotes back to summary

isParseUnescapedQuotes	back to summary
public boolean isParseUnescapedQuotes() Deprecated use `getUnescapedQuoteHandling()` instead. The configuration returned by `getUnescapedQuoteHandling()` will override this setting if not null. Indicates whether the CSV parser should accept unescaped quotes inside quoted values and parse them normally. Defaults to `true`. Returns:boolean a flag indicating whether or not the CSV parser should accept unescaped quotes inside quoted values. Annotations @Deprecated

public boolean isParseUnescapedQuotes()

Deprecated

use getUnescapedQuoteHandling() instead. The configuration returned by getUnescapedQuoteHandling() will override this setting if not null.

Indicates whether the CSV parser should accept unescaped quotes inside quoted values and parse them normally. Defaults to true.

Returns:boolean

a flag indicating whether or not the CSV parser should accept unescaped quotes inside quoted values.

Annotations

@Deprecated

isParseUnescapedQuotesUntilDelimiter back to summary

isParseUnescapedQuotesUntilDelimiter	back to summary
public boolean isParseUnescapedQuotesUntilDelimiter() Deprecated use `getUnescapedQuoteHandling()` instead. The configuration returned by `getUnescapedQuoteHandling()` will override this setting if not null. When parsing unescaped quotes, indicates the parser should stop accumulating characters and consider the value parsed when a delimiter is found. (defaults to `true`) Returns:boolean a flag indicating that the parser should stop accumulating values when a field delimiter character is found when parsing unquoted and unescaped values. Annotations @Deprecated

public boolean isParseUnescapedQuotesUntilDelimiter()

Deprecated

use getUnescapedQuoteHandling() instead. The configuration returned by getUnescapedQuoteHandling() will override this setting if not null.

When parsing unescaped quotes, indicates the parser should stop accumulating characters and consider the value parsed when a delimiter is found. (defaults to true)

Returns:boolean

a flag indicating that the parser should stop accumulating values when a field delimiter character is found when parsing unquoted and unescaped values.

Annotations

@Deprecated

isQuoteDetectionEnabled back to summary

isQuoteDetectionEnabled	back to summary
public final boolean isQuoteDetectionEnabled() Returns a flag indicating whether the parser should analyze the input to discover the quote character. The quote escape will also be detected as part of this process. Note that the detection process is not guaranteed to discover the correct quote & escape. In this case the characters provided by `CsvFormat#getQuote()` and `CsvFormat#getQuoteEscape()` will be used Returns:boolean a flag indicating whether the parser should analyze the input to discover the quote character. The quote escape will also be detected as part of this process.

public final boolean isQuoteDetectionEnabled()

Returns a flag indicating whether the parser should analyze the input to discover the quote character. The quote escape will also be detected as part of this process.

Note that the detection process is not guaranteed to discover the correct quote & escape. In this case the characters provided by CsvFormat#getQuote() and CsvFormat#getQuoteEscape() will be used

Returns:boolean: a flag indicating whether the parser should analyze the input to discover the quote character. The quote escape will also be detected as part of this process.

newCharAppender	back to summary
protected CharAppender newCharAppender() Overrides com.univocity.parsers.common.CommonParserSettings.newCharAppender. Returns an instance of CharAppender with the configured limit of maximum characters per column and the default value used to represent an empty value (when the String parsed from the input, within quotes, is empty) This overrides the parent's version because the CSV parser does not rely on the appender to identify null values, but on the other hand, the appender is required to identify empty values. Returns:CharAppender an instance of CharAppender with the configured limit of maximum characters per column and the default value used to represent an empty value (when the String parsed from the input, within quotes, is empty) Annotations @Override

newCharAppender

back to summary

protected CharAppender newCharAppender()

Overrides com.univocity.parsers.common.CommonParserSettings.newCharAppender.

Returns an instance of CharAppender with the configured limit of maximum characters per column and the default value used to represent an empty value (when the String parsed from the input, within quotes, is empty)

This overrides the parent's version because the CSV parser does not rely on the appender to identify null values, but on the other hand, the appender is required to identify empty values.

Returns:CharAppender

an instance of CharAppender with the configured limit of maximum characters per column and the default value used to represent an empty value (when the String parsed from the input, within quotes, is empty)

Annotations

@Override

setDelimiterDetectionEnabled back to summary

setDelimiterDetectionEnabled	back to summary
public final void setDelimiterDetectionEnabled(boolean separatorDetectionEnabled) Configures the parser to analyze the input before parsing to discover the column delimiter character. Note that the detection process is not guaranteed to discover the correct column delimiter. The first character in the list of delimiters allowed for detection will be used, if available, otherwise the delimiter returned by `CsvFormat#getDelimiter()` will be used. Parameters separatorDetectionEnabled:boolean the flag to enable/disable discovery of the column delimiter character. to `true`, in order of priority.

public final void setDelimiterDetectionEnabled(boolean separatorDetectionEnabled)

Configures the parser to analyze the input before parsing to discover the column delimiter character.

Note that the detection process is not guaranteed to discover the correct column delimiter. The first character in the list of delimiters allowed for detection will be used, if available, otherwise the delimiter returned by CsvFormat#getDelimiter() will be used.

Parameters

separatorDetectionEnabled:boolean: the flag to enable/disable discovery of the column delimiter character. to true, in order of priority.

setDelimiterDetectionEnabled back to summary

setDelimiterDetectionEnabled	back to summary
public final void setDelimiterDetectionEnabled(boolean separatorDetectionEnabled, char... delimitersForDetection) Configures the parser to analyze the input before parsing to discover the column delimiter character. Note that the detection process is not guaranteed to discover the correct column delimiter. The first character in the list of delimiters allowed for detection will be used, if available, otherwise the delimiter returned by `CsvFormat#getDelimiter()` will be used. Parameters separatorDetectionEnabled:boolean the flag to enable/disable discovery of the column delimiter character. delimitersForDetection:char[] possible delimiters for detection when `isDelimiterDetectionEnabled()` evaluates to `true`, in order of priority.

public final void setDelimiterDetectionEnabled(boolean separatorDetectionEnabled, char... delimitersForDetection)

Configures the parser to analyze the input before parsing to discover the column delimiter character.

Parameters

separatorDetectionEnabled:boolean: the flag to enable/disable discovery of the column delimiter character.
delimitersForDetection:char[]: possible delimiters for detection when isDelimiterDetectionEnabled() evaluates to true, in order of priority.

setEmptyValue	back to summary
public void setEmptyValue(String emptyValue) Sets the String representation of an empty value (defaults to null) When reading, if the parser does not read any character from the input, and the input is within quotes, the empty is used instead of an empty string Parameters emptyValue:String the String representation of an empty value

setEmptyValue

back to summary

public void setEmptyValue(String emptyValue)

Sets the String representation of an empty value (defaults to null)

When reading, if the parser does not read any character from the input, and the input is within quotes, the empty is used instead of an empty string

Parameters

emptyValue:String: the String representation of an empty value

setEscapeUnquotedValues back to summary

setEscapeUnquotedValues	back to summary
public void setEscapeUnquotedValues(boolean escapeUnquotedValues) Configures the parser to process escape sequences in unquoted values. Defaults to `false`. By default, this is disabled and if the input is `A""B,C`, the resulting value will be `[A""B] and [C]` (i.e. the content is read as-is). However, if the parser is configured to process escape sequences in unquoted values, the result will be `[A"B] and [C]` Parameters escapeUnquotedValues:boolean a flag indicating whether escape sequences should be processed in unquoted values

public void setEscapeUnquotedValues(boolean escapeUnquotedValues)

Configures the parser to process escape sequences in unquoted values. Defaults to false.

Parameters

escapeUnquotedValues:boolean: a flag indicating whether escape sequences should be processed in unquoted values

setFormatDetectorRowSampleCount	back to summary
public void setFormatDetectorRowSampleCount(int formatDetectorRowSampleCount) Updates the number of sample rows used in the CSV format auto-detection process (defaults to 20) Parameters formatDetectorRowSampleCount:int the number of sample rows used in the CSV format auto-detection process

setFormatDetectorRowSampleCount

back to summary

public void setFormatDetectorRowSampleCount(int formatDetectorRowSampleCount)

Updates the number of sample rows used in the CSV format auto-detection process (defaults to 20)

Parameters

formatDetectorRowSampleCount:int: the number of sample rows used in the CSV format auto-detection process

setIgnoreLeadingWhitespacesInQuotes back to summary

setIgnoreLeadingWhitespacesInQuotes	back to summary
public void setIgnoreLeadingWhitespacesInQuotes(boolean ignoreLeadingWhitespacesInQuotes) Defines whether or not leading whitespaces from quoted values should be skipped (defaults to false) Note: if `keepQuotes` evaluates to `true`, values won't be trimmed. Parameters ignoreLeadingWhitespacesInQuotes:boolean whether leading whitespaces from quoted values should be skipped

public void setIgnoreLeadingWhitespacesInQuotes(boolean ignoreLeadingWhitespacesInQuotes)

Defines whether or not leading whitespaces from quoted values should be skipped (defaults to false) Note: if keepQuotes evaluates to true, values won't be trimmed.

Parameters

ignoreLeadingWhitespacesInQuotes:boolean: whether leading whitespaces from quoted values should be skipped

setIgnoreTrailingWhitespacesInQuotes back to summary

setIgnoreTrailingWhitespacesInQuotes	back to summary
public void setIgnoreTrailingWhitespacesInQuotes(boolean ignoreTrailingWhitespacesInQuotes) Defines whether or not trailing whitespaces from quoted values should be skipped (defaults to false) Note: if `keepQuotes` evaluates to `true`, values won't be trimmed. Parameters ignoreTrailingWhitespacesInQuotes:boolean whether trailing whitespaces from quoted values should be skipped

public void setIgnoreTrailingWhitespacesInQuotes(boolean ignoreTrailingWhitespacesInQuotes)

Defines whether or not trailing whitespaces from quoted values should be skipped (defaults to false) Note: if keepQuotes evaluates to true, values won't be trimmed.

Parameters

ignoreTrailingWhitespacesInQuotes:boolean: whether trailing whitespaces from quoted values should be skipped

setKeepEscapeSequences back to summary

setKeepEscapeSequences	back to summary
public final void setKeepEscapeSequences(boolean keepEscapeSequences) Configures the parser to keep any escape sequences if they are present in the input (i.e. a quote escape sequence such as 2 double quotes `""` won't be replaced by a single double quote `"`). This is disabled by default Parameters keepEscapeSequences:boolean the flag indicating whether escape sequences should be kept (and not replaced) by the parser.

public final void setKeepEscapeSequences(boolean keepEscapeSequences)

Configures the parser to keep any escape sequences if they are present in the input (i.e. a quote escape sequence such as 2 double quotes "" won't be replaced by a single double quote ").

This is disabled by default

Parameters

keepEscapeSequences:boolean: the flag indicating whether escape sequences should be kept (and not replaced) by the parser.

setKeepQuotes back to summary

setKeepQuotes	back to summary
public void setKeepQuotes(boolean keepQuotes) Configures the parser to keep enclosing quote characters in the values parsed from the input. Defaults to `false` Parameters keepQuotes:boolean flag indicating whether enclosing quotes should be maintained when parsing quoted values.

public void setKeepQuotes(boolean keepQuotes)

Configures the parser to keep enclosing quote characters in the values parsed from the input.

Defaults to false

Parameters

keepQuotes:boolean: flag indicating whether enclosing quotes should be maintained when parsing quoted values.

setNormalizeLineEndingsWithinQuotes back to summary

setNormalizeLineEndingsWithinQuotes	back to summary
public void setNormalizeLineEndingsWithinQuotes(boolean normalizeLineEndingsWithinQuotes) Configures the parser to replace line separators, specified in `Format#getLineSeparator()` by the normalized line separator character specified in `Format#getNormalizedNewline()`, even on quoted values. This is enabled by default and is used to ensure data be read on any platform without introducing unwanted blank lines. For example, consider the quoted value `"Line1 \r\n Line2"`. If this is parsed using `"\r\n"` as the line separator sequence, and the normalized new line is set to `'\n'` (the default), the output will be: `[Line1 \n Line2]` However, if the value is meant to be kept untouched, and the original line separator should be maintained, set the `normalizeLineEndingsWithinQuotes` to `false`. This will make the parser read the value as-is, producing: `[Line1 \r\n Line2]` Parameters normalizeLineEndingsWithinQuotes:boolean flag indicating whether line separators in quoted values should be replaced by the the character specified in `Format#getNormalizedNewline()` .

public void setNormalizeLineEndingsWithinQuotes(boolean normalizeLineEndingsWithinQuotes)

Configures the parser to replace line separators, specified in Format#getLineSeparator() by the normalized line separator character specified in Format#getNormalizedNewline(), even on quoted values. This is enabled by default and is used to ensure data be read on any platform without introducing unwanted blank lines. For example, consider the quoted value "Line1 \r\n Line2". If this is parsed using "\r\n" as the line separator sequence, and the normalized new line is set to '\n' (the default), the output will be: [Line1 \n Line2] However, if the value is meant to be kept untouched, and the original line separator should be maintained, set the normalizeLineEndingsWithinQuotes to false. This will make the parser read the value as-is, producing: [Line1 \r\n Line2]

Parameters

normalizeLineEndingsWithinQuotes:boolean: flag indicating whether line separators in quoted values should be replaced by the the character specified in Format#getNormalizedNewline() .

setParseUnescapedQuotes back to summary

setParseUnescapedQuotes	back to summary
public void setParseUnescapedQuotes(boolean parseUnescapedQuotes) Deprecated use `setUnescapedQuoteHandling(UnescapedQuoteHandling)` instead. The configuration returned by `getUnescapedQuoteHandling()` will override this setting if not null. Configures how to handle unescaped quotes inside quoted values. If set to `true`, the parser will parse the quote normally as part of the value. If set the `false`, a `TextParsingException` will be thrown. Defaults to `true`. Parameters parseUnescapedQuotes:boolean indicates whether or not the CSV parser should accept unescaped quotes inside quoted values. Annotations @Deprecated

public void setParseUnescapedQuotes(boolean parseUnescapedQuotes)

Deprecated

use setUnescapedQuoteHandling(UnescapedQuoteHandling) instead. The configuration returned by getUnescapedQuoteHandling() will override this setting if not null.

Configures how to handle unescaped quotes inside quoted values. If set to true, the parser will parse the quote normally as part of the value. If set the false, a TextParsingException will be thrown. Defaults to true.

Parameters

parseUnescapedQuotes:boolean: indicates whether or not the CSV parser should accept unescaped quotes inside quoted values.

Annotations

@Deprecated

setParseUnescapedQuotesUntilDelimiter back to summary

public void setParseUnescapedQuotesUntilDelimiter(boolean parseUnescapedQuotesUntilDelimiter)

Deprecated

use setUnescapedQuoteHandling(UnescapedQuoteHandling) instead. The configuration returned by getUnescapedQuoteHandling() will override this setting if not null.

Configures the parser to process values with unescaped quotes, and stop accumulating characters and consider the value parsed when a delimiter is found. (defaults to true)

Parameters

parseUnescapedQuotesUntilDelimiter:boolean: a flag indicating that the parser should stop accumulating values when a field delimiter character is found when parsing unquoted and unescaped values.

Annotations

@Deprecated

setQuoteDetectionEnabled back to summary

public final void setQuoteDetectionEnabled(boolean quoteDetectionEnabled)

Configures the parser to analyze the input before parsing to discover the quote character. The quote escape will also be detected as part of this process.

Note that the detection process is not guaranteed to discover the correct quote & escape. In this case the characters provided by CsvFormat#getQuote() and CsvFormat#getQuoteEscape() will be used

Parameters

quoteDetectionEnabled:boolean: the flag to enable/disable discovery of the quote character. The quote escape will also be detected as part of this process.

setUnescapedQuoteHandling back to summary

public void setUnescapedQuoteHandling(UnescapedQuoteHandling unescapedQuoteHandling)

Configures the handling of values with unescaped quotes. Defaults to null, for backward compatibility with isParseUnescapedQuotes() and isParseUnescapedQuotesUntilDelimiter(). If set to a non-null value, this setting will override the configuration of isParseUnescapedQuotes() and isParseUnescapedQuotesUntilDelimiter().

Parameters

unescapedQuoteHandling:UnescapedQuoteHandling: the handling method to be used when unescaped quotes are found in the input.

trimQuotedValues back to summary

public final void trimQuotedValues(boolean trim)

Configures the parser to trim any whitespaces around values extracted from within quotes. Shorthand for setIgnoreLeadingWhitespacesInQuotes(boolean) and setIgnoreTrailingWhitespacesInQuotes(boolean)

Note

if keepQuotes evaluates to true, values won't be trimmed.

Parameters

trim:boolean: a flag indicating whether whitespaces around values extracted from a quoted field should be removed

public Class CsvParserSettings

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail