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

Modifier and Type	Field and Description
private char	escapeChar
private char	escapedTabChar
private boolean	joinLines
private char	newLine

Constructor Summary

Access	Constructor and Description
public	TsvWriter(TsvWriterSettings the TSV writer configuration settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized.
public	TsvWriter(Writer the output resource that will receive TSV records produced by this class. writer, TsvWriterSettings the TSV writer configuration settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized.
public	TsvWriter(File the output file that will receive TSV records produced by this class. file, TsvWriterSettings the TSV writer configuration settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized.
public	TsvWriter(File the output file that will receive TSV records produced by this class. file, String the encoding of the file encoding, TsvWriterSettings the TSV writer configuration settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized.
public	TsvWriter(File the output file that will receive TSV records produced by this class. file, Charset the encoding of the file encoding, TsvWriterSettings the TSV writer configuration settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized.
public	TsvWriter(OutputStream the output stream that will be written with the TSV records produced by this class. output, TsvWriterSettings the TSV writer configuration settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized.
public	TsvWriter(OutputStream the output stream that will be written with the TSV records produced by this class. output, String the encoding of the stream encoding, TsvWriterSettings the TSV writer configuration settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized.
public	TsvWriter(OutputStream the output stream that will be written with the TSV records produced by this class. output, Charset the encoding of the stream encoding, TsvWriterSettings the TSV writer configuration settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized.

Method Summary

Modifier and Type	Method and Description
private void	append(String element, boolean allowTrim)
protected final void	initialize(TsvWriterSettings the TSV writer configuration settings) Implements abstract com.univocity.parsers.common.AbstractWriter.initialize. Initializes the TSV writer with TSV-specific configuration
protected void	processRow(Object[] the data to be written to the output in the expected format. row) Implements abstract com.univocity.parsers.common.AbstractWriter.processRow. Format-specific implementation for writing a single record into the output.

Inherited from com.univocity.parsers.common.AbstractWriter:: addStringValues addValue addValue addValue addValues addValues allowTrim appendToRow appendToRow appendValueToRow close commentRow commentRowToString discardValues enableNewlineAfterRecord expand flush getRecordCount getStringValue processObjectRecords processObjectRecordsAndClose processObjectRecordsAndClose processObjectRecordsToString processObjectRecordsToString processRecord processRecord processRecord processRecord processRecord processRecords processRecords processRecords processRecords processRecords processRecordsAndClose processRecordsAndClose processRecordsAndClose processRecordsAndClose processRecordsToString processRecordsToString processRecordsToString processRecordsToString processRecordToString processRecordToString processRecordToString processRecordToString processRecordToString processValuesToRow processValuesToString skipLeadingWhitespace updateFieldExclusion updateFieldExclusion updateFieldSelection updateFieldSelection writeEmptyRow writeHeaders writeHeaders writeHeaders writeHeadersToString writeHeadersToString writeHeadersToString writeObjectRows writeObjectRowsAndClose writeObjectRowsAndClose writeObjectRowsToString writeRecord writeRecords writeRecords writeRecordsAndClose writeRecordsAndClose writeRecordsAndClose writeRecordsToString writeRecordsToString writeRecordToString writeRow writeRow writeRow writeRow writeRow writeRow writeRows writeRows writeRows writeRows writeRows writeRowsAndClose writeRowsAndClose writeRowsAndClose writeRowsAndClose writeRowsAndClose writeRowsToString writeRowsToString writeRowsToString writeRowsToString writeRowsToString writeRowToString writeRowToString writeRowToString writeRowToString writeRowToString writeStringRows writeStringRows writeStringRows writeStringRowsAndClose writeStringRowsAndClose writeStringRowsAndClose writeStringRowsToString writeStringRowsToString writeStringRowsToString writeValuesToRow writeValuesToString

Field Detail

escapeChar	back to summary
private char escapeChar

escapedTabChar	back to summary
private char escapedTabChar

joinLines	back to summary
private boolean joinLines

newLine	back to summary
private char newLine

Constructor Detail

TsvWriter back to summary

TsvWriter	back to summary
public TsvWriter(TsvWriterSettings settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized. Important Note by not providing an instance of `java.io.Writer` to this constructor, only the operations that write to Strings are available. Parameters settings:TsvWriterSettings the TSV writer configuration

public TsvWriter(TsvWriterSettings settings)

The TsvWriter supports all settings provided by TsvWriterSettings, and requires this configuration to be properly initialized.

Important Note

by not providing an instance of java.io.Writer to this constructor, only the operations that write to Strings are available.

Parameters

settings:TsvWriterSettings: the TSV writer configuration

TsvWriter back to summary

TsvWriter	back to summary
public TsvWriter(Writer writer, TsvWriterSettings settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized. Parameters writer:Writer the output resource that will receive TSV records produced by this class. settings:TsvWriterSettings the TSV writer configuration

public TsvWriter(Writer writer, TsvWriterSettings settings)

The TsvWriter supports all settings provided by TsvWriterSettings, and requires this configuration to be properly initialized.

Parameters

writer:Writer: the output resource that will receive TSV records produced by this class.
settings:TsvWriterSettings: the TSV writer configuration

TsvWriter back to summary

TsvWriter	back to summary
public TsvWriter(File file, TsvWriterSettings settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized. Parameters file:File the output file that will receive TSV records produced by this class. settings:TsvWriterSettings the TSV writer configuration

public TsvWriter(File file, TsvWriterSettings settings)

The TsvWriter supports all settings provided by TsvWriterSettings, and requires this configuration to be properly initialized.

Parameters

file:File: the output file that will receive TSV records produced by this class.
settings:TsvWriterSettings: the TSV writer configuration

TsvWriter back to summary

TsvWriter	back to summary
public TsvWriter(File file, String encoding, TsvWriterSettings settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized. Parameters file:File the output file that will receive TSV records produced by this class. encoding:String the encoding of the file settings:TsvWriterSettings the TSV writer configuration

public TsvWriter(File file, String encoding, TsvWriterSettings settings)

The TsvWriter supports all settings provided by TsvWriterSettings, and requires this configuration to be properly initialized.

Parameters

file:File: the output file that will receive TSV records produced by this class.
encoding:String: the encoding of the file
settings:TsvWriterSettings: the TSV writer configuration

TsvWriter back to summary

TsvWriter	back to summary
public TsvWriter(File file, Charset encoding, TsvWriterSettings settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized. Parameters file:File the output file that will receive TSV records produced by this class. encoding:Charset the encoding of the file settings:TsvWriterSettings the TSV writer configuration

public TsvWriter(File file, Charset encoding, TsvWriterSettings settings)

The TsvWriter supports all settings provided by TsvWriterSettings, and requires this configuration to be properly initialized.

Parameters

file:File: the output file that will receive TSV records produced by this class.
encoding:Charset: the encoding of the file
settings:TsvWriterSettings: the TSV writer configuration

TsvWriter back to summary

TsvWriter	back to summary
public TsvWriter(OutputStream output, TsvWriterSettings settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized. Parameters output:OutputStream the output stream that will be written with the TSV records produced by this class. settings:TsvWriterSettings the TSV writer configuration

public TsvWriter(OutputStream output, TsvWriterSettings settings)

The TsvWriter supports all settings provided by TsvWriterSettings, and requires this configuration to be properly initialized.

Parameters

output:OutputStream: the output stream that will be written with the TSV records produced by this class.
settings:TsvWriterSettings: the TSV writer configuration

TsvWriter back to summary

TsvWriter	back to summary
public TsvWriter(OutputStream output, String encoding, TsvWriterSettings settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized. Parameters output:OutputStream the output stream that will be written with the TSV records produced by this class. encoding:String the encoding of the stream settings:TsvWriterSettings the TSV writer configuration

public TsvWriter(OutputStream output, String encoding, TsvWriterSettings settings)

The TsvWriter supports all settings provided by TsvWriterSettings, and requires this configuration to be properly initialized.

Parameters

output:OutputStream: the output stream that will be written with the TSV records produced by this class.
encoding:String: the encoding of the stream
settings:TsvWriterSettings: the TSV writer configuration

TsvWriter back to summary

TsvWriter	back to summary
public TsvWriter(OutputStream output, Charset encoding, TsvWriterSettings settings) The TsvWriter supports all settings provided by `TsvWriterSettings`, and requires this configuration to be properly initialized. Parameters output:OutputStream the output stream that will be written with the TSV records produced by this class. encoding:Charset the encoding of the stream settings:TsvWriterSettings the TSV writer configuration

public TsvWriter(OutputStream output, Charset encoding, TsvWriterSettings settings)

The TsvWriter supports all settings provided by TsvWriterSettings, and requires this configuration to be properly initialized.

Parameters

output:OutputStream: the output stream that will be written with the TSV records produced by this class.
encoding:Charset: the encoding of the stream
settings:TsvWriterSettings: the TSV writer configuration

Method Detail

append	back to summary
private void append(String element, boolean allowTrim)

initialize	back to summary
protected final void initialize(TsvWriterSettings settings) Implements abstract com.univocity.parsers.common.AbstractWriter.initialize. Initializes the TSV writer with TSV-specific configuration Parameters settings:TsvWriterSettings the TSV writer configuration

initialize

back to summary

protected final void initialize(TsvWriterSettings settings)

Implements abstract com.univocity.parsers.common.AbstractWriter.initialize.

Initializes the TSV writer with TSV-specific configuration

Parameters

settings:TsvWriterSettings: the TSV writer configuration

processRow back to summary

processRow	back to summary
protected void processRow(Object[] row) Implements abstract com.univocity.parsers.common.AbstractWriter.processRow. Doc from com.univocity.parsers.common.AbstractWriter.processRow. Format-specific implementation for writing a single record into the output. The AbstractWriter handles the initialization and processing of the output until it is ready to be written (generally, reorganizing it and passing it on to a `RowWriterProcessor`). It then delegates the record to the writer-specific implementation defined by `processRow(Object[])`. In general, an implementation of `AbstractWriter#processRow(Object[])` will perform the following steps: Iterate over each object in the given input and convert it to the expected String representation. The conversion must happen using the provided `AbstractWriter#appender` object. The an individual value is processed, the `AbstractWriter#appendValueToRow()` method must be called. This will clear the accumulated value in `AbstractWriter#appender` and add it to the output row. Format specific separators and other characters must be introduced to the output row using `AbstractWriter#appendToRow(char)` Once the `processRow(Object[])` method returns, a row will be written to the output with the processed information, and a newline will be automatically written after the given contents, unless this is a `com.univocity.parsers.fixed.FixedWidthWriter` whose `FixedWidthWriterSettings#getWriteLineSeparatorAfterRecord()` evaluates to `false`. The newline character sequence will conform to what is specified in `Format#getLineSeparator()` This cycle repeats until the writing process is stopped by the user or an error happens. In case of errors, the unchecked exception `TextWritingException` will be thrown and all resources in use will be closed automatically. The exception should contain the cause and more information about the output state when the error happened. Parameters row:Object[] the data to be written to the output in the expected format. Annotations @Override

protected void processRow(Object[] row)

Implements abstract com.univocity.parsers.common.AbstractWriter.processRow.

Doc from com.univocity.parsers.common.AbstractWriter.processRow.

Format-specific implementation for writing a single record into the output. The AbstractWriter handles the initialization and processing of the output until it is ready to be written (generally, reorganizing it and passing it on to a RowWriterProcessor). It then delegates the record to the writer-specific implementation defined by processRow(Object[]). In general, an implementation of AbstractWriter#processRow(Object[]) will perform the following steps:

Iterate over each object in the given input and convert it to the expected String representation.
The conversion must happen using the provided AbstractWriter#appender object. The an individual value is processed, the AbstractWriter#appendValueToRow() method must be called. This will clear the accumulated value in AbstractWriter#appender and add it to the output row.
Format specific separators and other characters must be introduced to the output row using AbstractWriter#appendToRow(char)

Once the processRow(Object[]) method returns, a row will be written to the output with the processed information, and a newline will be automatically written after the given contents, unless this is a com.univocity.parsers.fixed.FixedWidthWriter whose FixedWidthWriterSettings#getWriteLineSeparatorAfterRecord() evaluates to false. The newline character sequence will conform to what is specified in Format#getLineSeparator() This cycle repeats until the writing process is stopped by the user or an error happens. In case of errors, the unchecked exception TextWritingException will be thrown and all resources in use will be closed automatically. The exception should contain the cause and more information about the output state when the error happened.

Parameters

row:Object[]: the data to be written to the output in the expected format.

Annotations

@Override

public Class TsvWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail