Package com.univocity.parsers.tsv
Class TsvParserSettings
- java.lang.Object
-
- com.univocity.parsers.common.CommonSettings<F>
-
- com.univocity.parsers.common.CommonParserSettings<TsvFormat>
-
- com.univocity.parsers.tsv.TsvParserSettings
-
- All Implemented Interfaces:
java.lang.Cloneable
public class TsvParserSettings extends CommonParserSettings<TsvFormat>
This is the configuration class used by the TSV parser (TsvParser
)It supports the configuration options provided by
CommonParserSettings
only- See Also:
TsvParser
,TsvFormat
,CommonParserSettings
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
lineJoiningEnabled
-
Fields inherited from class com.univocity.parsers.common.CommonParserSettings
headerExtractionEnabled
-
-
Constructor Summary
Constructors Constructor Description TsvParserSettings()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addConfiguration(java.util.Map<java.lang.String,java.lang.Object> out)
TsvParserSettings
clone()
Clones this configuration object.TsvParserSettings
clone(boolean clearInputSpecificSettings)
Clones this configuration object to reuse user-provided settings.protected TsvFormat
createDefaultFormat()
Returns the default TsvFormat configured to handle TSV inputsboolean
isLineJoiningEnabled()
Identifies whether or lines ending with the escape character (defined byTsvFormat.getEscapeChar()
and followed by a line separator character should be joined with the following line.void
setLineJoiningEnabled(boolean lineJoiningEnabled)
Defines how the parser should handle escaped line separators.-
Methods inherited from class com.univocity.parsers.common.CommonParserSettings
addInputAnalysisProcess, clearInputSpecificSettings, configureFromAnnotations, getInputAnalysisProcesses, getInputBufferSize, getNumberOfRecordsToRead, getNumberOfRowsToSkip, getProcessor, getReadInputOnSeparateThread, getRowProcessor, isAutoClosingEnabled, isColumnReorderingEnabled, isCommentCollectionEnabled, isCommentProcessingEnabled, isHeaderExtractionEnabled, isLineSeparatorDetectionEnabled, newCharAppender, newCharInputReader, setAutoClosingEnabled, setColumnReorderingEnabled, 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, setAutoConfigurationEnabled, setErrorContentLength, setFormat, setHeaders, setIgnoreLeadingWhitespaces, setIgnoreTrailingWhitespaces, setMaxCharsPerColumn, setMaxColumns, setNullValue, setProcessorErrorHandler, setRowProcessorErrorHandler, setSkipBitsAsWhitespace, setSkipEmptyLines, toString, trimValues
-
-
-
-
Method Detail
-
isLineJoiningEnabled
public boolean isLineJoiningEnabled()
Identifies whether or lines ending with the escape character (defined byTsvFormat.getEscapeChar()
and followed by a line separator character should be joined with the following line. Typical examples include inputs where lines end with sequences such as:'\'+'\n'
and'\'+'\r'+'\n'
. When line joining is disabled (the default), theTsvParser
converts sequences containing the escape character (typically '\') followed by characters 'n' or 'r' into a '\n' or '\r' character. It will continue processing the contents found in the same line, until a new line character is found. If line joining is enabled, theTsvParser
will convert sequences containing the escape character, followed by characters '\n', '\r' or '\r\n', into a '\n' or '\r' character. It will continue processing the contents found in the next line, until a new line character is found, given it is not preceded by another escape character.- Returns:
true
if line joining is enabled, otherwisefalse
-
setLineJoiningEnabled
public void setLineJoiningEnabled(boolean lineJoiningEnabled)
Defines how the parser should handle escaped line separators. By enabling lines joining, lines ending with the escape character (defined byTsvFormat.getEscapeChar()
and followed by a line separator character will be joined with the following line. Typical examples include inputs where lines end with sequences such as:'\'+'\n'
and'\'+'\r'+'\n'
. When line joining is disabled (the default), theTsvParser
converts sequences containing the escape character (typically '\') followed by characters 'n' or 'r' into a '\n' or '\r' character. It will continue processing the contents found in the same line, until a new line character is found. If line joining is enabled, theTsvParser
will convert sequences containing the escape character, followed by characters '\n', '\r' or '\r\n', into a '\n' or '\r' character. It will continue processing the contents found in the next line, until a new line character is found, given it is not preceded by another escape character.- Parameters:
lineJoiningEnabled
- a flag indicating whether or not to enable line joining.
-
createDefaultFormat
protected TsvFormat createDefaultFormat()
Returns the default TsvFormat configured to handle TSV inputs- Specified by:
createDefaultFormat
in classCommonSettings<TsvFormat>
- Returns:
- and instance of TsvFormat configured to handle TSV
-
addConfiguration
protected void addConfiguration(java.util.Map<java.lang.String,java.lang.Object> out)
- Overrides:
addConfiguration
in classCommonParserSettings<TsvFormat>
-
clone
public final TsvParserSettings clone()
Description copied from class:CommonSettings
Clones this configuration object. Use alternativeCommonSettings.clone(boolean)
method to reset properties that are specific to a given input, such as header names and selection of fields.- Overrides:
clone
in classCommonParserSettings<TsvFormat>
- Returns:
- a copy of all configurations applied to the current instance.
-
clone
public final TsvParserSettings 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 theclearInputSpecificSettings
flag is set totrue
- Overrides:
clone
in classCommonParserSettings<TsvFormat>
- 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.
-
-