univocity-parsers 2.9.1 · com.univocity.parsers.csv.CsvWriter

Modifier and Type	Field and Description
private char	delimiter
private boolean	dontProcessNormalizedNewLines
private char	escapeChar
private char	escapeEscape
private boolean	escapeUnquoted
private boolean	inputNotEscaped
private char	maxTrigger
private char[]	multiDelimiter
private char	newLine
private boolean[]	quotationTriggers
private boolean	quoteAllFields
private char	quoteChar
private Set<Integer>	quotedColumns
private FieldSelector	quotedFieldSelector
private boolean	quoteNulls

Constructor Summary

Access	Constructor and Description
public	CsvWriter(CsvWriterSettings the CSV writer configuration settings) The CsvWriter supports all settings provided by `CsvWriterSettings`, and requires this configuration to be properly initialized.
public	CsvWriter(Writer the output resource that will receive CSV records produced by this class. writer, CsvWriterSettings the CSV writer configuration settings) The CsvWriter supports all settings provided by `CsvWriterSettings`, and requires this configuration to be properly initialized.
public	CsvWriter(File the output file that will receive CSV records produced by this class. file, CsvWriterSettings the CSV writer configuration settings) The CsvWriter supports all settings provided by `CsvWriterSettings`, and requires this configuration to be properly initialized.
public	CsvWriter(File the output file that will receive CSV records produced by this class. file, String the encoding of the file encoding, CsvWriterSettings the CSV writer configuration settings) The CsvWriter supports all settings provided by `CsvWriterSettings`, and requires this configuration to be properly initialized.
public	CsvWriter(File the output file that will receive CSV records produced by this class. file, Charset the encoding of the file encoding, CsvWriterSettings the CSV writer configuration settings) The CsvWriter supports all settings provided by `CsvWriterSettings`, and requires this configuration to be properly initialized.
public	CsvWriter(OutputStream the output stream that will be written with the CSV records produced by this class. output, CsvWriterSettings the CSV writer configuration settings) The CsvWriter supports all settings provided by `CsvWriterSettings`, and requires this configuration to be properly initialized.
public	CsvWriter(OutputStream the output stream that will be written with the CSV records produced by this class. output, String the encoding of the stream encoding, CsvWriterSettings the CSV writer configuration settings) The CsvWriter supports all settings provided by `CsvWriterSettings`, and requires this configuration to be properly initialized.
public	CsvWriter(OutputStream the output stream that will be written with the CSV records produced by this class. output, Charset the encoding of the stream encoding, CsvWriterSettings the CSV writer configuration 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
private boolean	append(int columnIndex, boolean isElementQuoted, boolean allowTrim, String element)
private void	appendQuoted(int start, boolean allowTrim, String element)
protected final void	initialize(CsvWriterSettings the CSV writer configuration settings) Implements abstract com.univocity.parsers.common.AbstractWriter.initialize. Initializes the CSV writer with CSV-specific configuration
private boolean	matchMultiDelimiter(String element, int from)
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.
private boolean	quoteElement(int start, String element)

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

delimiter	back to summary
private char delimiter

dontProcessNormalizedNewLines	back to summary
private boolean dontProcessNormalizedNewLines

escapeChar	back to summary
private char escapeChar

escapeEscape	back to summary
private char escapeEscape

escapeUnquoted	back to summary
private boolean escapeUnquoted

inputNotEscaped	back to summary
private boolean inputNotEscaped

maxTrigger	back to summary
private char maxTrigger

multiDelimiter	back to summary
private char[] multiDelimiter

newLine	back to summary
private char newLine

quotationTriggers	back to summary
private boolean[] quotationTriggers

quoteAllFields	back to summary
private boolean quoteAllFields

quoteChar	back to summary
private char quoteChar

quotedColumns	back to summary
private Set<Integer> quotedColumns

quotedFieldSelector	back to summary
private FieldSelector quotedFieldSelector

quoteNulls	back to summary
private boolean quoteNulls

Constructor Detail

CsvWriter back to summary

CsvWriter	back to summary
public CsvWriter(CsvWriterSettings settings) The CsvWriter supports all settings provided by `CsvWriterSettings`, 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:CsvWriterSettings the CSV writer configuration

public CsvWriter(CsvWriterSettings settings)

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

CsvWriter back to summary

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

public CsvWriter(Writer writer, CsvWriterSettings settings)

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

Parameters

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

CsvWriter back to summary

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

public CsvWriter(File file, CsvWriterSettings settings)

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

Parameters

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

CsvWriter back to summary

CsvWriter	back to summary
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:File the output file that will receive CSV records produced by this class. encoding:String the encoding of the file settings:CsvWriterSettings the CSV writer configuration

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:File: the output file that will receive CSV records produced by this class.
encoding:String: the encoding of the file
settings:CsvWriterSettings: the CSV writer configuration

CsvWriter back to summary

CsvWriter	back to summary
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:File the output file that will receive CSV records produced by this class. encoding:Charset the encoding of the file settings:CsvWriterSettings the CSV writer configuration

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:File: the output file that will receive CSV records produced by this class.
encoding:Charset: the encoding of the file
settings:CsvWriterSettings: the CSV writer configuration

CsvWriter back to summary

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

public CsvWriter(OutputStream output, CsvWriterSettings settings)

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

Parameters

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

CsvWriter back to summary

CsvWriter	back to summary
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:OutputStream the output stream that will be written with the CSV records produced by this class. encoding:String the encoding of the stream settings:CsvWriterSettings the CSV writer configuration

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:OutputStream: the output stream that will be written with the CSV records produced by this class.
encoding:String: the encoding of the stream
settings:CsvWriterSettings: the CSV writer configuration

CsvWriter back to summary

CsvWriter	back to summary
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:OutputStream the output stream that will be written with the CSV records produced by this class. encoding:Charset the encoding of the stream settings:CsvWriterSettings the CSV writer configuration

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:OutputStream: the output stream that will be written with the CSV records produced by this class.
encoding:Charset: the encoding of the stream
settings:CsvWriterSettings: the CSV writer configuration

Method Detail

append	back to summary
private boolean append(int columnIndex, boolean isElementQuoted, boolean allowTrim, String element)

appendQuoted	back to summary
private void appendQuoted(int start, boolean allowTrim, String element)

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

initialize

back to summary

protected final void initialize(CsvWriterSettings settings)

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

Initializes the CSV writer with CSV-specific configuration

Parameters

settings:CsvWriterSettings: the CSV writer configuration

matchMultiDelimiter	back to summary
private boolean matchMultiDelimiter(String element, int from)

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

quoteElement	back to summary
private boolean quoteElement(int start, String element)

public Class CsvWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail