univocity-parsers 2.9.1 · com.univocity.parsers.tsv.TsvParserSettings

Modifier and Type	Field and Description
private boolean	lineJoiningEnabled

Access	Constructor and Description
public	TsvParserSettings()

Modifier and Type	Method and Description
protected void	addConfiguration(Map<String, Object> out) Overrides com.univocity.parsers.common.CommonParserSettings.addConfiguration.
public final TsvParserSettings	clone() Overrides com.univocity.parsers.common.CommonParserSettings.clone. Clones this configuration object.
public final TsvParserSettings	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 TsvFormat	Returns: and instance of TsvFormat configured to handle TSV createDefaultFormat() Implements abstract com.univocity.parsers.common.CommonSettings.createDefaultFormat. Returns the default TsvFormat configured to handle TSV inputs
public boolean	Returns: `true` if line joining is enabled, otherwise `false` isLineJoiningEnabled() Identifies whether or lines ending with the escape character (defined by `TsvFormat#getEscapeChar()` and followed by a line separator character should be joined with the following line.
public void	setLineJoiningEnabled(boolean a flag indicating whether or not to enable line joining. lineJoiningEnabled) Defines how the parser should handle escaped line separators.

lineJoiningEnabled	back to summary
private boolean lineJoiningEnabled

TsvParserSettings	back to summary
public TsvParserSettings()

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 TsvParserSettings 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:TsvParserSettings a copy of all configurations applied to the current instance. Annotations @Override

public final TsvParserSettings 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:TsvParserSettings

a copy of all configurations applied to the current instance.

Annotations

@Override

clone back to summary

clone	back to summary
public final TsvParserSettings 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:TsvParserSettings a copy of the configurations applied to the current instance. Annotations @Override

public final TsvParserSettings 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:TsvParserSettings

a copy of the configurations applied to the current instance.

Annotations

@Override

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

createDefaultFormat

back to summary

protected TsvFormat createDefaultFormat()

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

Returns the default TsvFormat configured to handle TSV inputs

Returns:TsvFormat

and instance of TsvFormat configured to handle TSV

Annotations

@Override

isLineJoiningEnabled back to summary

isLineJoiningEnabled	back to summary
public boolean isLineJoiningEnabled() Identifies whether or lines ending with the escape character (defined by `TsvFormat#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), the `TsvParser` 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, the `TsvParser` 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:boolean `true` if line joining is enabled, otherwise `false`

public boolean isLineJoiningEnabled()

Identifies whether or lines ending with the escape character (defined by TsvFormat#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), the TsvParser 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, the TsvParser 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:boolean: true if line joining is enabled, otherwise false

setLineJoiningEnabled back to summary

setLineJoiningEnabled	back to summary
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 by `TsvFormat#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), the `TsvParser` 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, the `TsvParser` 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:boolean a flag indicating whether or not to enable line joining.

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 by TsvFormat#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), the TsvParser 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, the TsvParser 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:boolean: a flag indicating whether or not to enable line joining.

public Class TsvParserSettings

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail