public class TsvWriterSettings extends CommonWriterSettings<TsvFormat>
TsvWriter
)
It does not offer additional configuration options on top of the ones provided by the CommonWriterSettings
TsvWriter
,
TsvFormat
,
CommonWriterSettings
Constructor and Description |
---|
TsvWriterSettings() |
Modifier and Type | Method and Description |
---|---|
protected void |
addConfiguration(Map<String,Object> out) |
TsvWriterSettings |
clone()
Clones this configuration object.
|
TsvWriterSettings |
clone(boolean clearInputSpecificSettings)
Clones this configuration object to reuse user-provided settings.
|
protected TsvFormat |
createDefaultFormat()
Returns the default TsvFormat.
|
boolean |
isLineJoiningEnabled()
Identifies whether values containing line endings should have the line separator written using
the escape character (defined by
TsvFormat.getEscapeChar() followed by the actual line separator character
instead of other characters such as the standard letters 'n' and 'r'
When line joining is disabled (the default), the TsvWriter will convert new line characters into
sequences containing the escape character (typically '\') followed by characters 'n' or 'r'. |
void |
setLineJoiningEnabled(boolean lineJoiningEnabled)
Defines how the writer should handle the escaping of line separators.
|
clearInputSpecificSettings, configureFromAnnotations, getEmptyValue, getExpandIncompleteRows, getRowWriterProcessor, isColumnReorderingEnabled, isHeaderWritingEnabled, setColumnReorderingEnabled, setEmptyValue, setExpandIncompleteRows, setHeaderWritingEnabled, setRowWriterProcessor
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
public boolean isLineJoiningEnabled()
TsvFormat.getEscapeChar()
followed by the actual line separator character
instead of other characters such as the standard letters 'n' and 'r'
When line joining is disabled (the default), the TsvWriter
will convert new line characters into
sequences containing the escape character (typically '\') followed by characters 'n' or 'r'.
No matter how many line separators the values written contain, the will be escaped and the entire output
of a record will be written into a single line of text. For example, '\n' and '\r' characters will be
written as: '\'+'n'
and '\'+'r'
.
If line joining is enabled, the TsvWriter
will convert line new line characters into sequences
containing the escape character, followed by characters '\n', '\r' or both.
A new line of text will be generated for each line separator found in the value to be written, "marking" the end
of each line with the escape character to indicate the record continues on the next line. For example, '\n' and '\r'
characters will be written as: '\'+'\n'
and '\'+'\r'
.true
if line joining is enabled, otherwise false
public void setLineJoiningEnabled(boolean lineJoiningEnabled)
TsvFormat.getEscapeChar()
followed by the actual line separator character
instead of other characters such as the standard letters 'n' and 'r'
When line joining is disabled (the default), the TsvWriter
will convert new line characters into
sequences containing the escape character (typically '\') followed by characters 'n' or 'r'.
No matter how many line separators the values written contain, the will be escaped and the entire output
of a record will be written into a single line of text. For example, '\n' and '\r' characters will be
written as: '\'+'n'
and '\'+'r'
.
If line joining is enabled, the TsvWriter
will convert line new line characters into sequences
containing the escape character, followed by characters '\n', '\r' or both.
A new line of text will be generated for each line separator found in the value to be written, "marking" the end
of each line with the escape character to indicate the record continues on the next line. For example, '\n' and '\r'
characters will be written as: '\'+'\n'
and '\'+'\r'
.lineJoiningEnabled
- a flag indicating whether or not to enable line joining.protected TsvFormat createDefaultFormat()
createDefaultFormat
in class CommonSettings<TsvFormat>
protected void addConfiguration(Map<String,Object> out)
addConfiguration
in class CommonWriterSettings<TsvFormat>
public final TsvWriterSettings clone()
CommonSettings
CommonSettings.clone(boolean)
method to reset properties that are
specific to a given input, such as header names and selection of fields.clone
in class CommonWriterSettings<TsvFormat>
public final TsvWriterSettings clone(boolean clearInputSpecificSettings)
CommonSettings
clearInputSpecificSettings
flag is set to true
clone
in class CommonWriterSettings<TsvFormat>
clearInputSpecificSettings
- flag indicating whether to clear settings that are likely to be associated with a given input.Copyright © 2023 uniVocity Software Pty Ltd. All rights reserved.