univocity-parsers 2.9.1 · com.univocity.parsers.fixed.FixedWidthWriter

Modifier and Type	Field and Description
private FieldAlignment	alignment
private FieldAlignment	defaultHeaderAlignment
private boolean	defaultHeaderPadding
private char	defaultPadding
private FieldAlignment[]	fieldAlignments
private int[]	fieldLengths
private char[]	fieldPaddings
private boolean[]	ignore
private int	ignoreCount
private int	length
private Lookup[]	lookaheadFormats
private Lookup	lookbehindFormat
private Lookup[]	lookbehindFormats
private char[]	lookupChars
private char	padding
private FieldAlignment[]	rootAlignments
private boolean[]	rootIgnore
private int[]	rootLengths
private char[]	rootPaddings

Constructor Summary

Access	Constructor and Description
public	FixedWidthWriter(FixedWidthWriterSettings the fixed-width writer configuration settings) The FixedWidthWriter supports all settings provided by `FixedWidthWriterSettings`, and requires this configuration to be properly initialized.
public	FixedWidthWriter(Writer the output resource that will receive fixed-width records produced by this class. writer, FixedWidthWriterSettings the fixed-width writer configuration settings) The FixedWidthWriter supports all settings provided by `FixedWidthWriterSettings`, and requires this configuration to be properly initialized.
public	FixedWidthWriter(File the output file that will receive fixed-width records produced by this class. file, FixedWidthWriterSettings the fixed-width writer configuration settings) The FixedWidthWriter supports all settings provided by `FixedWidthWriterSettings`, and requires this configuration to be properly initialized.
public	FixedWidthWriter(File the output file that will receive fixed-width records produced by this class. file, String the encoding of the file encoding, FixedWidthWriterSettings the fixed-width writer configuration settings) The FixedWidthWriter supports all settings provided by `FixedWidthWriterSettings`, and requires this configuration to be properly initialized.
public	FixedWidthWriter(File the output file that will receive fixed-width records produced by this class. file, Charset the encoding of the file encoding, FixedWidthWriterSettings the fixed-width writer configuration settings) The FixedWidthWriter supports all settings provided by `FixedWidthWriterSettings`, and requires this configuration to be properly initialized.
public	FixedWidthWriter(OutputStream the output stream that will be written with the fixed-width records produced by this class. output, FixedWidthWriterSettings the fixed-width writer configuration settings) The FixedWidthWriter supports all settings provided by `FixedWidthWriterSettings`, and requires this configuration to be properly initialized.
public	FixedWidthWriter(OutputStream the output stream that will be written with the fixed-width records produced by this class. output, String the encoding of the stream encoding, FixedWidthWriterSettings the fixed-width writer configuration settings) The FixedWidthWriter supports all settings provided by `FixedWidthWriterSettings`, and requires this configuration to be properly initialized.
public	FixedWidthWriter(OutputStream the output stream that will be written with the fixed-width records produced by this class. output, Charset the encoding of the stream encoding, FixedWidthWriterSettings the fixed-width writer configuration settings) The FixedWidthWriter supports all settings provided by `FixedWidthWriterSettings`, 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(FixedWidthWriterSettings the Fixed-Width writer configuration settings) Implements abstract com.univocity.parsers.common.AbstractWriter.initialize. Initializes the Fixed-Width writer with CSV-specific configuration
private void	processElement(String element, boolean allowTrim)
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

alignment	back to summary
private FieldAlignment alignment

defaultHeaderAlignment	back to summary
private FieldAlignment defaultHeaderAlignment

defaultHeaderPadding	back to summary
private boolean defaultHeaderPadding

defaultPadding	back to summary
private char defaultPadding

fieldAlignments	back to summary
private FieldAlignment[] fieldAlignments

fieldLengths	back to summary
private int[] fieldLengths

fieldPaddings	back to summary
private char[] fieldPaddings

ignore	back to summary
private boolean[] ignore

ignoreCount	back to summary
private int ignoreCount

length	back to summary
private int length

lookaheadFormats	back to summary
private Lookup[] lookaheadFormats

lookbehindFormat	back to summary
private Lookup lookbehindFormat

lookbehindFormats	back to summary
private Lookup[] lookbehindFormats

lookupChars	back to summary
private char[] lookupChars

padding	back to summary
private char padding

rootAlignments	back to summary
private FieldAlignment[] rootAlignments

rootIgnore	back to summary
private boolean[] rootIgnore

rootLengths	back to summary
private int[] rootLengths

rootPaddings	back to summary
private char[] rootPaddings

Constructor Detail

FixedWidthWriter back to summary

FixedWidthWriter	back to summary
public FixedWidthWriter(FixedWidthWriterSettings settings) The FixedWidthWriter supports all settings provided by `FixedWidthWriterSettings`, 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:FixedWidthWriterSettings the fixed-width writer configuration

public FixedWidthWriter(FixedWidthWriterSettings settings)

The FixedWidthWriter supports all settings provided by FixedWidthWriterSettings, 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:FixedWidthWriterSettings: the fixed-width writer configuration

FixedWidthWriter back to summary

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

public FixedWidthWriter(Writer writer, FixedWidthWriterSettings settings)

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

Parameters

writer:Writer: the output resource that will receive fixed-width records produced by this class.
settings:FixedWidthWriterSettings: the fixed-width writer configuration

FixedWidthWriter back to summary

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

public FixedWidthWriter(File file, FixedWidthWriterSettings settings)

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

Parameters

file:File: the output file that will receive fixed-width records produced by this class.
settings:FixedWidthWriterSettings: the fixed-width writer configuration

FixedWidthWriter back to summary

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

public FixedWidthWriter(File file, String encoding, FixedWidthWriterSettings settings)

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

Parameters

file:File: the output file that will receive fixed-width records produced by this class.
encoding:String: the encoding of the file
settings:FixedWidthWriterSettings: the fixed-width writer configuration

FixedWidthWriter back to summary

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

public FixedWidthWriter(File file, Charset encoding, FixedWidthWriterSettings settings)

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

Parameters

file:File: the output file that will receive fixed-width records produced by this class.
encoding:Charset: the encoding of the file
settings:FixedWidthWriterSettings: the fixed-width writer configuration

FixedWidthWriter back to summary

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

public FixedWidthWriter(OutputStream output, FixedWidthWriterSettings settings)

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

Parameters

output:OutputStream: the output stream that will be written with the fixed-width records produced by this class.
settings:FixedWidthWriterSettings: the fixed-width writer configuration

FixedWidthWriter back to summary

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

public FixedWidthWriter(OutputStream output, String encoding, FixedWidthWriterSettings settings)

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

Parameters

output:OutputStream: the output stream that will be written with the fixed-width records produced by this class.
encoding:String: the encoding of the stream
settings:FixedWidthWriterSettings: the fixed-width writer configuration

FixedWidthWriter back to summary

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

public FixedWidthWriter(OutputStream output, Charset encoding, FixedWidthWriterSettings settings)

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

Parameters

output:OutputStream: the output stream that will be written with the fixed-width records produced by this class.
encoding:Charset: the encoding of the stream
settings:FixedWidthWriterSettings: the fixed-width writer configuration

Method Detail

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

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

initialize

back to summary

protected final void initialize(FixedWidthWriterSettings settings)

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

Initializes the Fixed-Width writer with CSV-specific configuration

Parameters

settings:FixedWidthWriterSettings: the Fixed-Width writer configuration

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

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 FixedWidthWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail