com.univocity.parsers.csv

Class CsvWriter

java.lang.Object

com.univocity.parsers.common.AbstractWriter<CsvWriterSettings>

com.univocity.parsers.csv.CsvWriter

public class CsvWriter
extends AbstractWriter<CsvWriterSettings>

A powerful and flexible CSV writer implementation.

Author:

Univocity Software Pty Ltd - [email protected]

See Also:

CsvFormat, CsvWriterSettings, CsvParser, AbstractWriter

Field Summary

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

appender, comment, emptyValue, expandRows, headers, headerTrimFlags, ignoreLeading, ignoreTrailing, nullValue, recordCount, usingNullOrEmptyValue, whitespaceRangeStart, writingHeaders

Constructor Summary

Constructors

Constructor and Description
CsvWriter(CsvWriterSettings settings) The CsvWriter supports all settings provided by CsvWriterSettings, and requires this configuration to be properly initialized.
CsvWriter(File file, Charset encoding, CsvWriterSettings settings) The CsvWriter supports all settings provided by CsvWriterSettings, and requires this configuration to be properly initialized.
CsvWriter(File file, CsvWriterSettings settings) The CsvWriter supports all settings provided by CsvWriterSettings, and requires this configuration to be properly initialized.
CsvWriter(File file, String encoding, CsvWriterSettings settings) The CsvWriter supports all settings provided by CsvWriterSettings, and requires this configuration to be properly initialized.
CsvWriter(OutputStream output, Charset encoding, CsvWriterSettings settings) The CsvWriter supports all settings provided by CsvWriterSettings, and requires this configuration to be properly initialized.
CsvWriter(OutputStream output, CsvWriterSettings settings) The CsvWriter supports all settings provided by CsvWriterSettings, and requires this configuration to be properly initialized.
CsvWriter(OutputStream output, String encoding, CsvWriterSettings settings) The CsvWriter supports all settings provided by CsvWriterSettings, and requires this configuration to be properly initialized.
CsvWriter(Writer writer, CsvWriterSettings settings) The CsvWriter supports all settings provided by CsvWriterSettings, and requires this configuration to be properly initialized.

Method Summary

Modifier and Type	Method and Description
protected void	initialize(CsvWriterSettings settings) Initializes the CSV writer with CSV-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, 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

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvWriter

public CsvWriter(CsvWriterSettings settings)

The CsvWriter supports all settings provided by CsvWriterSettings, 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 CSV writer configuration

CsvWriter

public CsvWriter(Writer writer,
                 CsvWriterSettings settings)

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

Parameters:

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

settings - the CSV writer configuration

CsvWriter

public CsvWriter(File file,
                 CsvWriterSettings settings)

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

Parameters:

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

settings - the CSV writer configuration

CsvWriter

public CsvWriter(File file,
                 String encoding,
                 CsvWriterSettings settings)

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

Parameters:

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

encoding - the encoding of the file

settings - the CSV writer configuration

CsvWriter

public CsvWriter(File file,
                 Charset encoding,
                 CsvWriterSettings settings)

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

Parameters:

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

encoding - the encoding of the file

settings - the CSV writer configuration

CsvWriter

public CsvWriter(OutputStream output,
                 CsvWriterSettings settings)

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

Parameters:

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

settings - the CSV writer configuration

CsvWriter

public CsvWriter(OutputStream output,
                 String encoding,
                 CsvWriterSettings settings)

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

Parameters:

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

encoding - the encoding of the stream

settings - the CSV writer configuration

CsvWriter

public CsvWriter(OutputStream output,
                 Charset encoding,
                 CsvWriterSettings settings)

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

Parameters:

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

encoding - the encoding of the stream

settings - the CSV writer configuration

Method Detail

initialize

protected final void initialize(CsvWriterSettings settings)

Initializes the CSV writer with CSV-specific configuration

Specified by:

initialize in class AbstractWriter<CsvWriterSettings>

Parameters:

settings - the CSV 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<CsvWriterSettings>

Parameters:

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

See Also:

CharAppender, CommonWriterSettings