com.univocity.parsers.tsv
Class TsvWriter

java.lang.Object
  com.univocity.parsers.common.AbstractWriter<TsvWriterSettings>
      com.univocity.parsers.tsv.TsvWriter

public class TsvWriter
extends AbstractWriter<TsvWriterSettings>

A powerful and flexible TSV writer implementation.

Author:

uniVocity Software Pty Ltd - parsers@univocity.com

See Also:

TsvFormat, TsvWriterSettings, TsvParser, AbstractWriter

Field Summary

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

appender, emptyValue, nullValue, writingHeaders

Constructor Summary

TsvWriter(File file, Charset encoding, TsvWriterSettings settings)
The TsvWriter supports all settings provided by TsvWriterSettings, and requires this configuration to be properly initialized.

TsvWriter(File file, String encoding, TsvWriterSettings settings)
The TsvWriter supports all settings provided by TsvWriterSettings, and requires this configuration to be properly initialized.

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

TsvWriter(OutputStream output, Charset encoding, TsvWriterSettings settings)
The TsvWriter supports all settings provided by TsvWriterSettings, and requires this configuration to be properly initialized.

TsvWriter(OutputStream output, String encoding, TsvWriterSettings settings)
The TsvWriter supports all settings provided by TsvWriterSettings, and requires this configuration to be properly initialized.

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

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

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

Method Summary

protected void	initialize(TsvWriterSettings settings) Initializes the TSV writer with TSV-specific configuration
protected void	processRow(Object[] row) Format-specific implementation for writing a single record into the output.

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

addStringValues, addValue, addValue, addValue, addValues, addValues, appendToRow, appendValueToRow, close, commentRow, commentRowToString, discardValues, enableNewlineAfterRecord, flush, getRecordCount, getStringValue, processObjectRecords, processObjectRecordsAndClose, processObjectRecordsAndClose, processObjectRecordsToString, processObjectRecordsToString, processRecord, processRecord, processRecord, processRecord, processRecords, processRecords, processRecords, processRecords, processRecordsAndClose, processRecordsAndClose, processRecordsAndClose, processRecordsAndClose, processRecordsToString, processRecordsToString, processRecordsToString, processRecordsToString, processRecordToString, processRecordToString, processRecordToString, processRecordToString, processValuesToRow, processValuesToString, skipLeadingWhitespace, updateFieldExclusion, updateFieldExclusion, updateFieldSelection, updateFieldSelection, writeEmptyRow, writeHeaders, writeHeaders, writeHeaders, writeHeadersToString, writeHeadersToString, writeHeadersToString, writeObjectRows, writeObjectRowsAndClose, writeObjectRowsAndClose, writeObjectRowsToString, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TsvWriter

public TsvWriter(TsvWriterSettings settings)

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

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

Parameters:

settings - the TSV writer configuration

TsvWriter

public TsvWriter(Writer writer,
                 TsvWriterSettings settings)

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

Parameters:

writer - the output resource that will receive TSV records produced by this class.

settings - the TSV writer configuration

TsvWriter

public TsvWriter(File file,
                 TsvWriterSettings settings)

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

Parameters:

file - the output file that will receive TSV records produced by this class.

settings - the TSV writer configuration

TsvWriter

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 - the output file that will receive TSV records produced by this class.

encoding - the encoding of the file

settings - the TSV writer configuration

TsvWriter

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 - the output file that will receive TSV records produced by this class.

encoding - the encoding of the file

settings - the TSV writer configuration

TsvWriter

public TsvWriter(OutputStream output,
                 TsvWriterSettings settings)

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

Parameters:

output - the output stream that will be written with the TSV records produced by this class.

settings - the TSV writer configuration

TsvWriter

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 - the output stream that will be written with the TSV records produced by this class.

encoding - the encoding of the stream

settings - the TSV writer configuration

TsvWriter

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 - the output stream that will be written with the TSV records produced by this class.

encoding - the encoding of the stream

settings - the TSV writer configuration

Method Detail

initialize

protected final void initialize(TsvWriterSettings settings)

Initializes the TSV writer with TSV-specific configuration

Specified by:

initialize in class AbstractWriter<TsvWriterSettings>

Parameters:

settings - the TSV writer configuration

processRow

protected void processRow(Object[] row)

Description copied from class: AbstractWriter

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 AbstractWriter.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 AbstractWriter.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 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.

Specified by:

processRow in class AbstractWriter<TsvWriterSettings>

Parameters:

row - the data to be written to the output in the expected format.

See Also:

CharAppender, CommonWriterSettings