CsvParserSettings (univocity-parsers 2.10.1 API)

java.lang.Object
- com.univocity.parsers.common.CommonSettings<F>
- - com.univocity.parsers.common.CommonParserSettings<CsvFormat>
  - - com.univocity.parsers.csv.CsvParserSettings

All Implemented Interfaces:

Cloneable
```
public class CsvParserSettings
extends CommonParserSettings<CsvFormat>
```
This is the configuration class used by the CSV parser (CsvParser)
In addition to the configuration options provided by CommonParserSettings, the CSVParserSettings include:
- emptyValue (defaults to null): Defines a replacement string to signify an empty value (which is not a null value)
  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
Author:

Univocity Software Pty Ltd - parsers@univocity.com

See Also:

CsvParser, CsvFormat, CommonParserSettings

Field Summary
- Fields inherited from class com.univocity.parsers.common.CommonParserSettings
  headerExtractionEnabled

Constructor Summary

Constructors
Constructor and Description

CsvParserSettings()

Constructors
Constructor and Description
`CsvParserSettings()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addConfiguration(Map<String,Object> out)`
`CsvParserSettings`	`clone()` Clones this configuration object.
`CsvParserSettings`	`clone(boolean clearInputSpecificSettings)` Clones this configuration object to reuse user-provided settings.
`protected CsvFormat`	`createDefaultFormat()` Returns the default CsvFormat configured to handle CSV inputs compliant to the RFC4180 standard.
`void`	`detectFormatAutomatically()` Convenience method to turn on all format detection features in a single method call, namely: `setDelimiterDetectionEnabled(boolean, char[])` `setQuoteDetectionEnabled(boolean)` `CommonParserSettings.setLineSeparatorDetectionEnabled(boolean)`
`CsvParserSettings`	`detectFormatAutomatically(char... delimitersForDetection)` Convenience method to turn on all format detection features in a single method call, namely: `setDelimiterDetectionEnabled(boolean, char[])` `setQuoteDetectionEnabled(boolean)` `CommonParserSettings.setLineSeparatorDetectionEnabled(boolean)`
`char[]`	`getDelimitersForDetection()` Returns the sequence of possible delimiters for detection when `isDelimiterDetectionEnabled()` evaluates to `true`, in order of priority.
`String`	`getEmptyValue()` Returns the String representation of an empty value (defaults to null)
`int`	`getFormatDetectorRowSampleCount()` Returns the number of sample rows used in the CSV format auto-detection process (defaults to 20)
`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.
`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.
`boolean`	`getKeepQuotes()` Flag indicating whether the parser should keep enclosing quote characters in the values parsed from the input.
`UnescapedQuoteHandling`	`getUnescapedQuoteHandling()` Returns the method of handling values with unescaped quotes.
`boolean`	`isDelimiterDetectionEnabled()` Returns a flag indicating whether the parser should analyze the input to discover the column delimiter character.
`boolean`	`isEscapeUnquotedValues()` Indicates whether escape sequences should be processed in unquoted values.
`boolean`	`isKeepEscapeSequences()` Indicates whether the parser should keep any escape sequences if they are present in the input (i.e.
`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.
`boolean`	`isParseUnescapedQuotes()` Deprecated. use `getUnescapedQuoteHandling()` instead. The configuration returned by `getUnescapedQuoteHandling()` will override this setting if not null.
`boolean`	`isParseUnescapedQuotesUntilDelimiter()` Deprecated. use `getUnescapedQuoteHandling()` instead. The configuration returned by `getUnescapedQuoteHandling()` will override this setting if not null.
`boolean`	`isQuoteDetectionEnabled()` Returns a flag indicating whether the parser should analyze the input to discover the quote character.
`protected CharAppender`	`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)
`CsvParserSettings`	`setAutoConfigurationEnabled(boolean autoConfigurationEnabled)` Indicates whether this settings object can automatically derive configuration options.
`void`	`setDelimiterDetectionEnabled(boolean separatorDetectionEnabled)` Configures the parser to analyze the input before parsing to discover the column delimiter character.
`CsvParserSettings`	`setDelimiterDetectionEnabled(boolean separatorDetectionEnabled, char... delimitersForDetection)` Configures the parser to analyze the input before parsing to discover the column delimiter character.
`CsvParserSettings`	`setEmptyValue(String emptyValue)` Sets the String representation of an empty value (defaults to null)
`CsvParserSettings`	`setErrorContentLength(int errorContentLength)` Configures the parser/writer to limit the length of displayed contents being parsed/written in the exception message when an error occurs.
`CsvParserSettings`	`setEscapeUnquotedValues(boolean escapeUnquotedValues)` Configures the parser to process escape sequences in unquoted values.
`CsvParserSettings`	`setFormat(CsvFormat format)` Defines the format of the file to be parsed/written (returns the format's defaults).
`void`	`setFormatDetectorRowSampleCount(int formatDetectorRowSampleCount)` Updates the number of sample rows used in the CSV format auto-detection process (defaults to 20)
`CsvParserSettings`	`setHeaders(String... headers)` Defines the field names in the input/output, in the sequence they occur (defaults to null).
`CsvParserSettings`	`setHeadersDerivedFromClass(Class<?> headerSourceClass, String... headers)` Defines the field names in the input/output derived from a given class with `Parsed` annotated attributes/methods.
`CsvParserSettings`	`setIgnoreLeadingWhitespaces(boolean ignoreLeadingWhitespaces)` Defines whether or not leading whitespaces from values being read/written should be skipped (defaults to true)
`CsvParserSettings`	`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.
`CsvParserSettings`	`setIgnoreTrailingWhitespaces(boolean ignoreTrailingWhitespaces)` Defines whether or not trailing whitespaces from values being read/written should be skipped (defaults to true)
`CsvParserSettings`	`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.
`CsvParserSettings`	`setKeepEscapeSequences(boolean keepEscapeSequences)` Configures the parser to keep any escape sequences if they are present in the input (i.e.
`CsvParserSettings`	`setKeepQuotes(boolean keepQuotes)` Configures the parser to keep enclosing quote characters in the values parsed from the input.
`CsvParserSettings`	`setMaxCharsPerColumn(int maxCharsPerColumn)` Defines the maximum number of characters allowed for any given value being written/read.
`CsvParserSettings`	`setMaxColumns(int maxColumns)` Defines a hard limit of how many columns a record can have (defaults to 512).
`CsvParserSettings`	`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.
`CsvParserSettings`	`setNullValue(String emptyValue)` Sets the String representation of a null value (defaults to null)
`CsvParserSettings`	`setParseUnescapedQuotes(boolean parseUnescapedQuotes)` Deprecated. use `setUnescapedQuoteHandling(UnescapedQuoteHandling)` instead. The configuration returned by `getUnescapedQuoteHandling()` will override this setting if not null.
`CsvParserSettings`	`setParseUnescapedQuotesUntilDelimiter(boolean parseUnescapedQuotesUntilDelimiter)` Deprecated. use `setUnescapedQuoteHandling(UnescapedQuoteHandling)` instead. The configuration returned by `getUnescapedQuoteHandling()` will override this setting if not null.
`CsvParserSettings`	`setProcessorErrorHandler(ProcessorErrorHandler<? extends Context> processorErrorHandler)` Defines a custom error handler to capture and handle errors that might happen while processing records with a `Processor` or a `RowWriterProcessor` (i.e.
`CsvParserSettings`	`setQuoteDetectionEnabled(boolean quoteDetectionEnabled)` Configures the parser to analyze the input before parsing to discover the quote character.
`CsvParserSettings`	`setRowProcessorErrorHandler(RowProcessorErrorHandler rowProcessorErrorHandler)` Deprecated. Use the `setProcessorErrorHandler(ProcessorErrorHandler)` method as it allows format-specific error handlers to be built to work with different implementations of `Context`. Implementations based on `RowProcessorErrorHandler` allow only parsers who provide a `ParsingContext` to be used.
`CsvParserSettings`	`setSkipBitsAsWhitespace(boolean skipBitsAsWhitespace)` Configures the parser to skip bit values as whitespace.
`CsvParserSettings`	`setSkipEmptyLines(boolean skipEmptyLines)` Defines whether or not empty lines should be ignored (defaults to true)
`CsvParserSettings`	`setUnescapedQuoteHandling(UnescapedQuoteHandling unescapedQuoteHandling)` Configures the handling of values with unescaped quotes.
`CsvParserSettings`	`trimQuotedValues(boolean trim)` Configures the parser to trim any whitespaces around values extracted from within quotes.

Methods inherited from class com.univocity.parsers.common.CommonParserSettings
addInputAnalysisProcess, clearInputSpecificSettings, configureFromAnnotations, getInputAnalysisProcesses, getInputBufferSize, getNumberOfRecordsToRead, getNumberOfRowsToSkip, getProcessor, getReadInputOnSeparateThread, getRowProcessor, isAutoClosingEnabled, isBlankCommentCollectionEnabled, isColumnReorderingEnabled, isCommentCollectionEnabled, isCommentProcessingEnabled, isHeaderExtractionEnabled, isLineSeparatorDetectionEnabled, newCharInputReader, setAutoClosingEnabled, setColumnReorderingEnabled, setCommentCollectionEnabled, setCommentCollectionEnabled, setCommentProcessingEnabled, setHeaderExtractionEnabled, setInputBufferSize, setLineSeparatorDetectionEnabled, setNumberOfRecordsToRead, setNumberOfRowsToSkip, setProcessor, setReadInputOnSeparateThread, setRowProcessor

Methods inherited from class com.univocity.parsers.common.CommonSettings
excludeFields, excludeFields, excludeIndexes, getErrorContentLength, getFormat, getHeaders, getIgnoreLeadingWhitespaces, getIgnoreTrailingWhitespaces, getMaxCharsPerColumn, getMaxColumns, getNullValue, getProcessorErrorHandler, getRowProcessorErrorHandler, getSkipBitsAsWhitespace, getSkipEmptyLines, getWhitespaceRangeStart, isAutoConfigurationEnabled, isProcessorErrorHandlerDefined, selectFields, selectFields, selectIndexes, toString, trimValues

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CsvParserSettings
```
public CsvParserSettings()
```
- Method Detail
  - getEmptyValue
```
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:
    
    the String representation of an empty value
  - setEmptyValue
```
public CsvParserSettings 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 - the String representation of an empty value
    
    Returns:
    
    this CsvParserSettings instance
  - newCharAppender
```
protected CharAppender 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.
    
    Overrides:
    
    newCharAppender in class CommonParserSettings<CsvFormat>
    
    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)
  - createDefaultFormat
```
protected CsvFormat createDefaultFormat()
```
    Returns the default CsvFormat configured to handle CSV inputs compliant to the RFC4180 standard.
    
    Specified by:
    
    createDefaultFormat in class CommonSettings<CsvFormat>
    
    Returns:
    
    an instance of CsvFormat configured to handle CSV inputs compliant to the RFC4180 standard.
  - isParseUnescapedQuotes
```
@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:
    
    a flag indicating whether or not the CSV parser should accept unescaped quotes inside quoted values.
  - setParseUnescapedQuotes
```
@Deprecated
public CsvParserSettings 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 - indicates whether or not the CSV parser should accept unescaped quotes inside quoted values.
  - setParseUnescapedQuotesUntilDelimiter
```
@Deprecated
public CsvParserSettings 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 - 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
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:
    
    a flag indicating that the parser should stop accumulating values when a field delimiter character is found when parsing unquoted and unescaped values.
  - isEscapeUnquotedValues
```
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:
    
    true if escape sequences should be processed in unquoted values, otherwise false
  - setEscapeUnquotedValues
```
public CsvParserSettings 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 - a flag indicating whether escape sequences should be processed in unquoted values
    
    Returns:
    
    this CsvParserSettings instance
  - isKeepEscapeSequences
```
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:
    
    a flag indicating whether escape sequences should be kept (and not replaced) by the parser.
  - setKeepEscapeSequences
```
public final CsvParserSettings 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 - the flag indicating whether escape sequences should be kept (and not replaced) by the parser.
    
    Returns:
    
    this CsvParserSettings instance
  - isDelimiterDetectionEnabled
```
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:
    
    a flag indicating whether the parser should analyze the input to discover the column delimiter character.
  - setDelimiterDetectionEnabled
```
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 - the flag to enable/disable discovery of the column delimiter character. to true, in order of priority.
  - setDelimiterDetectionEnabled
```
public final CsvParserSettings 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 - the flag to enable/disable discovery of the column delimiter character.
    
    delimitersForDetection - possible delimiters for detection when isDelimiterDetectionEnabled() evaluates to true, in order of priority.
  - isQuoteDetectionEnabled
```
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:
    
    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.
  - setQuoteDetectionEnabled
```
public final CsvParserSettings 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 - the flag to enable/disable discovery of the quote character. The quote escape will also be detected as part of this process.
    
    Returns:
    
    this CsvParserSettings instance
  - detectFormatAutomatically
```
public final void detectFormatAutomatically()
```
    Convenience method to turn on all format detection features in a single method call, namely:
  - detectFormatAutomatically
```
public final CsvParserSettings detectFormatAutomatically(char... delimitersForDetection)
```
    Convenience method to turn on all format detection features in a single method call, namely:
    Parameters:
    
    delimitersForDetection - possible delimiters for detection, in order of priority.
    
    Returns:
    
    this CsvParserSettings instance
  - isNormalizeLineEndingsWithinQuotes
```
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:
    
    true if line separators in quoted values will be normalized, false otherwise
  - setNormalizeLineEndingsWithinQuotes
```
public CsvParserSettings 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 - flag indicating whether line separators in quoted values should be replaced by the the character specified in Format.getNormalizedNewline() .
    
    Returns:
    
    this CsvParserSettings instance
  - setUnescapedQuoteHandling
```
public CsvParserSettings 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 - the handling method to be used when unescaped quotes are found in the input.
    
    Returns:
    
    this CsvParserSettings instance
  - getUnescapedQuoteHandling
```
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:
    
    the handling method to be used when unescaped quotes are found in the input, or null if not set.
  - getKeepQuotes
```
public boolean getKeepQuotes()
```
    Flag indicating whether the parser should keep enclosing quote characters in the values parsed from the input.
    Defaults to false
    
    Returns:
    
    a flag indicating whether enclosing quotes should be maintained when parsing quoted values.
  - setKeepQuotes
```
public CsvParserSettings setKeepQuotes(boolean keepQuotes)
```
    Configures the parser to keep enclosing quote characters in the values parsed from the input.
    Defaults to false
    
    Parameters:
    
    keepQuotes - flag indicating whether enclosing quotes should be maintained when parsing quoted values.
    
    Returns:
    
    this CsvParserSettings instance
  - addConfiguration
```
protected void addConfiguration(Map<String,Object> out)
```
    Overrides:
    
    addConfiguration in class CommonParserSettings<CsvFormat>
  - clone
```
public final CsvParserSettings clone()
```
    Description copied from class: CommonSettings
    
    Clones this configuration object. Use alternative CommonSettings.clone(boolean) method to reset properties that are specific to a given input, such as header names and selection of fields.
    
    Overrides:
    
    clone in class CommonParserSettings<CsvFormat>
    
    Returns:
    
    a copy of all configurations applied to the current instance.
  - clone
```
public final CsvParserSettings 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 CommonParserSettings<CsvFormat>
    
    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.
  - getDelimitersForDetection
```
public final char[] getDelimitersForDetection()
```
    Returns the sequence of possible delimiters for detection when isDelimiterDetectionEnabled() evaluates to true, in order of priority.
    
    Returns:
    
    the possible delimiter characters, in order of priority.
  - getIgnoreTrailingWhitespacesInQuotes
```
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:
    
    true if trailing whitespaces from quoted values should be skipped, false otherwise
  - setIgnoreTrailingWhitespacesInQuotes
```
public CsvParserSettings 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 - whether trailing whitespaces from quoted values should be skipped
    
    Returns:
    
    this CsvParserSettings instance
  - getIgnoreLeadingWhitespacesInQuotes
```
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:
    
    true if leading whitespaces from quoted values should be skipped, false otherwise
  - setIgnoreLeadingWhitespacesInQuotes
```
public CsvParserSettings 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 - whether leading whitespaces from quoted values should be skipped
    
    Returns:
    
    this CsvParserSettings instance
  - trimQuotedValues
```
public final CsvParserSettings 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 - a flag indicating whether whitespaces around values extracted from a quoted field should be removed
    
    Returns:
    
    this CsvParserSettings instance
  - setNullValue
```
public CsvParserSettings setNullValue(String emptyValue)
```
    Sets the String representation of a null value (defaults to null)
    When reading, if the parser does not read any character from the input, the nullValue is used instead of an empty string
    When writing, if the writer has a null object to write to the output, the nullValue is used instead of an empty string
    
    Overrides:
    
    setNullValue in class CommonSettings<CsvFormat>
    
    Parameters:
    
    emptyValue - the String representation of a null value
    
    Returns:
    
    this CsvParserSettings instance
  - setMaxCharsPerColumn
```
public CsvParserSettings setMaxCharsPerColumn(int maxCharsPerColumn)
```
    Defines the maximum number of characters allowed for any given value being written/read. Used to avoid OutOfMemoryErrors (defaults to 4096).
    To enable auto-expansion of the internal array, set this property to -1
    
    Overrides:
    
    setMaxCharsPerColumn in class CommonSettings<CsvFormat>
    
    Parameters:
    
    maxCharsPerColumn - The maximum number of characters allowed for any given value being written/read
    
    Returns:
    
    this CsvParserSettings instance
  - setSkipEmptyLines
```
public CsvParserSettings setSkipEmptyLines(boolean skipEmptyLines)
```
    Defines whether or not empty lines should be ignored (defaults to true)
    when reading, if the parser reads a line that is empty, it will be skipped.
    when writing, if the writer receives an empty or null row to write to the output, it will be ignored
    
    Overrides:
    
    setSkipEmptyLines in class CommonSettings<CsvFormat>
    
    Parameters:
    
    skipEmptyLines - true if empty lines should be ignored, false otherwise
    
    Returns:
    
    this CsvParserSettings instance
  - setIgnoreTrailingWhitespaces
```
public CsvParserSettings setIgnoreTrailingWhitespaces(boolean ignoreTrailingWhitespaces)
```
    Defines whether or not trailing whitespaces from values being read/written should be skipped (defaults to true)
    
    Overrides:
    
    setIgnoreTrailingWhitespaces in class CommonSettings<CsvFormat>
    
    Parameters:
    
    ignoreTrailingWhitespaces - true if trailing whitespaces from values being read/written should be skipped, false otherwise
    
    Returns:
    
    this CsvParserSettings instance
  - setIgnoreLeadingWhitespaces
```
public CsvParserSettings setIgnoreLeadingWhitespaces(boolean ignoreLeadingWhitespaces)
```
    Defines whether or not leading whitespaces from values being read/written should be skipped (defaults to true)
    
    Overrides:
    
    setIgnoreLeadingWhitespaces in class CommonSettings<CsvFormat>
    
    Parameters:
    
    ignoreLeadingWhitespaces - true if leading whitespaces from values being read/written should be skipped, false otherwise
    
    Returns:
    
    this CsvParserSettings instance
  - setHeaders
```
public CsvParserSettings setHeaders(String... headers)
```
    Defines the field names in the input/output, in the sequence they occur (defaults to null).
    when reading, the given header names will be used to refer to each column irrespective of whether or not the input contains a header row
    when writing, the given header names will be used to refer to each column and can be used for writing the header row
    
    Overrides:
    
    setHeaders in class CommonSettings<CsvFormat>
    
    Parameters:
    
    headers - the field name sequence associated with each column in the input/output.
    
    Returns:
    
    this CsvParserSettings instance
  - setHeadersDerivedFromClass
```
public CsvParserSettings setHeadersDerivedFromClass(Class<?> headerSourceClass,
                                                    String... headers)
```
    Defines the field names in the input/output derived from a given class with Parsed annotated attributes/methods.
    when reading, the given header names will be used to refer to each column irrespective of whether or not the input contains a header row
    when writing, the given header names will be used to refer to each column and can be used for writing the header row
    
    Overrides:
    
    setHeadersDerivedFromClass in class CommonSettings<CsvFormat>
    
    Parameters:
    
    headerSourceClass - the class from which the headers have been derived.
    
    headers - the field name sequence associated with each column in the input/output.
    
    Returns:
    
    this CsvParserSettings instance
  - setMaxColumns
```
public CsvParserSettings setMaxColumns(int maxColumns)
```
    Defines a hard limit of how many columns a record can have (defaults to 512). You need this to avoid OutOfMemory errors in case of inputs that might be inconsistent with the format you are dealing with.
    
    Overrides:
    
    setMaxColumns in class CommonSettings<CsvFormat>
    
    Parameters:
    
    maxColumns - The maximum number of columns a record can have.
    
    Returns:
    
    this CsvParserSettings instance
  - setFormat
```
public CsvParserSettings setFormat(CsvFormat format)
```
    Defines the format of the file to be parsed/written (returns the format's defaults).
    
    Overrides:
    
    setFormat in class CommonSettings<CsvFormat>
    
    Parameters:
    
    format - The format of the file to be parsed/written
    
    Returns:
    
    this CsvParserSettings instance
  - setAutoConfigurationEnabled
```
public final CsvParserSettings setAutoConfigurationEnabled(boolean autoConfigurationEnabled)
```
    Indicates whether this settings object can automatically derive configuration options. This is used, for example, to define the headers when the user provides a BeanWriterProcessor where the bean class contains a Headers annotation, or to enable header extraction when the bean class of a BeanProcessor has attributes mapping to header names.
    
    Overrides:
    
    setAutoConfigurationEnabled in class CommonSettings<CsvFormat>
    
    Parameters:
    
    autoConfigurationEnabled - a flag to turn the automatic configuration feature on/off.
    
    Returns:
    
    this CsvParserSettings instance
  - setRowProcessorErrorHandler
```
@Deprecated
public CsvParserSettings setRowProcessorErrorHandler(RowProcessorErrorHandler rowProcessorErrorHandler)
```
    Deprecated. Use the setProcessorErrorHandler(ProcessorErrorHandler) method as it allows format-specific error handlers to be built to work with different implementations of Context. Implementations based on RowProcessorErrorHandler allow only parsers who provide a ParsingContext to be used.
    
    Defines a custom error handler to capture and handle errors that might happen while processing records with a RowProcessor or a RowWriterProcessor (i.e. non-fatal DataProcessingExceptions).
    The parsing parsing/writing won't stop (unless the error handler rethrows the DataProcessingException or manually stops the process).
    
    Overrides:
    
    setRowProcessorErrorHandler in class CommonSettings<CsvFormat>
    
    Parameters:
    
    rowProcessorErrorHandler - the callback error handler with custom code to manage occurrences of DataProcessingException.
    
    Returns:
    
    this CsvParserSettings instance
  - setProcessorErrorHandler
```
public CsvParserSettings setProcessorErrorHandler(ProcessorErrorHandler<? extends Context> processorErrorHandler)
```
    Defines a custom error handler to capture and handle errors that might happen while processing records with a Processor or a RowWriterProcessor (i.e. non-fatal DataProcessingExceptions).
    The parsing parsing/writing won't stop (unless the error handler rethrows the DataProcessingException or manually stops the process).
    
    Overrides:
    
    setProcessorErrorHandler in class CommonSettings<CsvFormat>
    
    Parameters:
    
    processorErrorHandler - the callback error handler with custom code to manage occurrences of DataProcessingException.
    
    Returns:
    
    this CsvParserSettings instance
  - setErrorContentLength
```
public CsvParserSettings setErrorContentLength(int errorContentLength)
```
    Configures the parser/writer to limit the length of displayed contents being parsed/written in the exception message when an error occurs.
    If set to 0, then no exceptions will include the content being manipulated in their attributes, and the "<omitted>" string will appear in error messages as the parsed/written content.
    
    defaults to -1 (no limit)
    .
    
    Overrides:
    
    setErrorContentLength in class CommonSettings<CsvFormat>
    
    Parameters:
    
    errorContentLength - maximum length of contents displayed in exception messages in case of errors while parsing/writing.
    
    Returns:
    
    this CsvParserSettings instance
  - setSkipBitsAsWhitespace
```
public final CsvParserSettings setSkipBitsAsWhitespace(boolean skipBitsAsWhitespace)
```
    Configures the parser to skip bit values as whitespace. By default the parser/writer removes control characters and considers a whitespace any character where character <= ' ' evaluates to true. This includes bit values, i.e. 0 (the \0 character) and 1 which might be produced by database dumps. Disabling this flag will prevent the parser/writer from discarding these characters when CommonSettings.getIgnoreLeadingWhitespaces() or CommonSettings.getIgnoreTrailingWhitespaces() evaluate to true.
    defaults to true
    
    Overrides:
    
    setSkipBitsAsWhitespace in class CommonSettings<CsvFormat>
    
    Parameters:
    
    skipBitsAsWhitespace - a flag indicating whether bit values (0 or 1) should be considered whitespace.
    
    Returns:
    
    this CsvParserSettings instance
  - getFormatDetectorRowSampleCount
```
public int getFormatDetectorRowSampleCount()
```
    Returns the number of sample rows used in the CSV format auto-detection process (defaults to 20)
    
    Returns:
    
    the number of sample rows used in the CSV format auto-detection process
  - setFormatDetectorRowSampleCount
```
public void setFormatDetectorRowSampleCount(int formatDetectorRowSampleCount)
```
    Updates the number of sample rows used in the CSV format auto-detection process (defaults to 20)
    
    Parameters:
    
    formatDetectorRowSampleCount - the number of sample rows used in the CSV format auto-detection process

Class CsvParserSettings

Field Summary

Fields inherited from class com.univocity.parsers.common.CommonParserSettings

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

CsvParserSettings

Method Detail

getEmptyValue

setEmptyValue

newCharAppender

createDefaultFormat

isParseUnescapedQuotes

setParseUnescapedQuotes

setParseUnescapedQuotesUntilDelimiter

isParseUnescapedQuotesUntilDelimiter

isEscapeUnquotedValues

setEscapeUnquotedValues

isKeepEscapeSequences

setKeepEscapeSequences

isDelimiterDetectionEnabled

setDelimiterDetectionEnabled

setDelimiterDetectionEnabled

isQuoteDetectionEnabled

setQuoteDetectionEnabled

detectFormatAutomatically

detectFormatAutomatically

isNormalizeLineEndingsWithinQuotes

setNormalizeLineEndingsWithinQuotes

setUnescapedQuoteHandling

getUnescapedQuoteHandling

getKeepQuotes

setKeepQuotes

addConfiguration

clone

clone

getDelimitersForDetection

getIgnoreTrailingWhitespacesInQuotes

setIgnoreTrailingWhitespacesInQuotes

getIgnoreLeadingWhitespacesInQuotes

setIgnoreLeadingWhitespacesInQuotes

trimQuotedValues

setNullValue

setMaxCharsPerColumn

setSkipEmptyLines

setIgnoreTrailingWhitespaces

setIgnoreLeadingWhitespaces

setHeaders

setHeadersDerivedFromClass

setMaxColumns

setFormat

setAutoConfigurationEnabled

setRowProcessorErrorHandler

setProcessorErrorHandler

setErrorContentLength

setSkipBitsAsWhitespace

getFormatDetectorRowSampleCount

setFormatDetectorRowSampleCount