public class FixedWidthWriter extends AbstractWriter<FixedWidthWriterSettings>
FixedWidthFormat
,
FixedWidthFields
,
FixedWidthWriterSettings
,
FixedWidthParser
,
AbstractWriter
appender, emptyValue, expandRows, nullValue, usingNullOrEmptyValue, whitespaceRangeStart, writingHeaders
Constructor and Description |
---|
FixedWidthWriter(File file,
Charset encoding,
FixedWidthWriterSettings settings)
The FixedWidthWriter supports all settings provided by
FixedWidthWriterSettings , and requires this configuration to be properly initialized. |
FixedWidthWriter(File file,
FixedWidthWriterSettings settings)
The FixedWidthWriter supports all settings provided by
FixedWidthWriterSettings , and requires this configuration to be properly initialized. |
FixedWidthWriter(File file,
String encoding,
FixedWidthWriterSettings settings)
The FixedWidthWriter supports all settings provided by
FixedWidthWriterSettings , and requires this configuration to be properly initialized. |
FixedWidthWriter(FixedWidthWriterSettings settings)
The FixedWidthWriter supports all settings provided by
FixedWidthWriterSettings , and requires this configuration to be properly initialized. |
FixedWidthWriter(OutputStream output,
Charset encoding,
FixedWidthWriterSettings settings)
The FixedWidthWriter supports all settings provided by
FixedWidthWriterSettings , and requires this configuration to be properly initialized. |
FixedWidthWriter(OutputStream output,
FixedWidthWriterSettings settings)
The FixedWidthWriter supports all settings provided by
FixedWidthWriterSettings , and requires this configuration to be properly initialized. |
FixedWidthWriter(OutputStream output,
String encoding,
FixedWidthWriterSettings settings)
The FixedWidthWriter supports all settings provided by
FixedWidthWriterSettings , and requires this configuration to be properly initialized. |
FixedWidthWriter(Writer writer,
FixedWidthWriterSettings settings)
The FixedWidthWriter supports all settings provided by
FixedWidthWriterSettings , and requires this configuration to be properly initialized. |
Modifier and Type | Method and Description |
---|---|
protected void |
initialize(FixedWidthWriterSettings settings)
Initializes the Fixed-Width writer with CSV-specific configuration
|
protected void |
processRow(Object[] row)
Format-specific implementation for writing a single record into the output.
|
addStringValues, addValue, addValue, addValue, addValues, addValues, appendToRow, appendValueToRow, close, commentRow, commentRowToString, discardValues, enableNewlineAfterRecord, expand, 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
public FixedWidthWriter(FixedWidthWriterSettings settings)
FixedWidthWriterSettings
, 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.
settings
- the fixed-width writer configurationpublic FixedWidthWriter(Writer writer, FixedWidthWriterSettings settings)
FixedWidthWriterSettings
, and requires this configuration to be properly initialized.writer
- the output resource that will receive fixed-width records produced by this class.settings
- the fixed-width writer configurationpublic FixedWidthWriter(File file, FixedWidthWriterSettings settings)
FixedWidthWriterSettings
, and requires this configuration to be properly initialized.file
- the output file that will receive fixed-width records produced by this class.settings
- the fixed-width writer configurationpublic FixedWidthWriter(File file, String encoding, FixedWidthWriterSettings settings)
FixedWidthWriterSettings
, and requires this configuration to be properly initialized.file
- the output file that will receive fixed-width records produced by this class.encoding
- the encoding of the filesettings
- the fixed-width writer configurationpublic FixedWidthWriter(File file, Charset encoding, FixedWidthWriterSettings settings)
FixedWidthWriterSettings
, and requires this configuration to be properly initialized.file
- the output file that will receive fixed-width records produced by this class.encoding
- the encoding of the filesettings
- the fixed-width writer configurationpublic FixedWidthWriter(OutputStream output, FixedWidthWriterSettings settings)
FixedWidthWriterSettings
, and requires this configuration to be properly initialized.output
- the output stream that will be written with the fixed-width records produced by this class.settings
- the fixed-width writer configurationpublic FixedWidthWriter(OutputStream output, String encoding, FixedWidthWriterSettings settings)
FixedWidthWriterSettings
, and requires this configuration to be properly initialized.output
- the output stream that will be written with the fixed-width records produced by this class.encoding
- the encoding of the streamsettings
- the fixed-width writer configurationpublic FixedWidthWriter(OutputStream output, Charset encoding, FixedWidthWriterSettings settings)
FixedWidthWriterSettings
, and requires this configuration to be properly initialized.output
- the output stream that will be written with the fixed-width records produced by this class.encoding
- the encoding of the streamsettings
- the fixed-width writer configurationprotected final void initialize(FixedWidthWriterSettings settings)
initialize
in class AbstractWriter<FixedWidthWriterSettings>
settings
- the Fixed-Width writer configurationprotected void processRow(Object[] row)
AbstractWriter
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:
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.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.
processRow
in class AbstractWriter<FixedWidthWriterSettings>
row
- the data to be written to the output in the expected format.CharAppender
,
CommonWriterSettings
Copyright © 2023 uniVocity Software Pty Ltd. All rights reserved.