Class CommonWriterSettings<F extends Format>
- Type Parameters:
F
- the format supported by this writer.
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
CsvWriterSettings
,FixedWidthWriterSettings
,TsvWriterSettings
AbstractWriter
)
By default, all writers work with, at least, the following configuration options in addition to the ones provided by CommonSettings
:
- rowWriterProcessor: a implementation of the interface
RowWriterProcessor
which processes input objects into a manageable format for writing.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
private String
private boolean
private Boolean
private RowWriterProcessor<?>
Fields inherited from class com.univocity.parsers.common.CommonSettings
headerSourceClass
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addConfiguration
(Map<String, Object> out) protected void
Clears settings that are likely to be specific to a given input.protected CommonWriterSettings
clone()
Clones this configuration object.protected CommonWriterSettings
clone
(boolean clearInputSpecificSettings) Clones this configuration object to reuse user-provided settings.protected void
configureFromAnnotations
(Class<?> beanClass) Configures the writer based on the annotations provided in a given classReturns the String representation of an empty value (defaults to null)final boolean
Indicates whether the writer should expand records with less columns than the number of headers.Returns the implementation of the interfaceRowWriterProcessor
which processes input objects into a manageable format for writing.boolean
Indicates whether fields selected using the field selection methods (defined by the parent classCommonSettings
) should be reordered (defaults to false).final boolean
Returns a flag indicating whether automatic writing of headers is enabled.(package private) final void
void
setColumnReorderingEnabled
(boolean columnReorderingEnabled) Defines whether fields selected using the field selection methods (defined by the parent classCommonSettings
) should be reordered (defaults to false).void
setEmptyValue
(String emptyValue) Sets the String representation of an empty value (defaults to null)final void
setExpandIncompleteRows
(boolean expandIncompleteRows) Defines whether the writer should expand records with less columns than the number of headers.final void
setHeaderWritingEnabled
(boolean headerWritingEnabled) Enables automatic writing of headers when they are available.void
setRowWriterProcessor
(RowWriterProcessor<?> rowWriterProcessor) Defines a processor for input objects that converts them into a manageable format for writing.Methods inherited from class com.univocity.parsers.common.CommonSettings
autoConfigure, createDefaultFormat, deriveHeadersFrom, excludeFields, excludeFields, excludeIndexes, getErrorContentLength, getFieldSelector, getFieldSet, getFormat, getHeaders, getIgnoreLeadingWhitespaces, getIgnoreTrailingWhitespaces, getMaxCharsPerColumn, getMaxColumns, getNullValue, getProcessorErrorHandler, getRowProcessorErrorHandler, getSkipBitsAsWhitespace, getSkipEmptyLines, getWhitespaceRangeStart, isAutoConfigurationEnabled, isProcessorErrorHandlerDefined, selectFields, selectFields, selectIndexes, setAutoConfigurationEnabled, setErrorContentLength, setFormat, setHeaders, setHeadersDerivedFromClass, setIgnoreLeadingWhitespaces, setIgnoreTrailingWhitespaces, setMaxCharsPerColumn, setMaxColumns, setNullValue, setProcessorErrorHandler, setRowProcessorErrorHandler, setSkipBitsAsWhitespace, setSkipEmptyLines, toString, trimValues
-
Field Details
-
rowWriterProcessor
-
headerWritingEnabled
-
emptyValue
-
expandIncompleteRows
private boolean expandIncompleteRows -
columnReorderingEnabled
private boolean columnReorderingEnabled
-
-
Constructor Details
-
CommonWriterSettings
public CommonWriterSettings()
-
-
Method Details
-
getEmptyValue
Returns the String representation of an empty value (defaults to null)When writing, if the writer has an empty String to write to the output, the emptyValue is used instead of an empty string
- Returns:
- the String representation of an empty value
-
setEmptyValue
Sets the String representation of an empty value (defaults to null)If the writer has an empty String to write to the output, the emptyValue is used instead of an empty string
- Parameters:
emptyValue
- the String representation of an empty value
-
getRowWriterProcessor
Returns the implementation of the interfaceRowWriterProcessor
which processes input objects into a manageable format for writing.- Returns:
- the implementation of the interface
RowWriterProcessor
which processes input objects into a manageable format for writing. - See Also:
-
setRowWriterProcessor
Defines a processor for input objects that converts them into a manageable format for writing.- Parameters:
rowWriterProcessor
- the implementation of the interfaceRowWriterProcessor
which processes input objects into a manageable format for writing.- See Also:
-
isHeaderWritingEnabled
public final boolean isHeaderWritingEnabled()Returns a flag indicating whether automatic writing of headers is enabled. If enabled, and headers are defined (or derived automatically ifCommonSettings.isAutoConfigurationEnabled()
evaluates totrue
), the writer will invoke theAbstractWriter.writeHeaders()
method automatically. In this case, attempting to explicitly write the headers will result in aTextWritingException
.Defaults to
false
- Returns:
- returns
true
if automatic header writing is enabled, otherwise false.
-
setHeaderWritingEnabled
public final void setHeaderWritingEnabled(boolean headerWritingEnabled) Enables automatic writing of headers when they are available. If enabled, and headers are defined (or derived automatically ifCommonSettings.isAutoConfigurationEnabled()
evaluates totrue
), the writer will invoke theAbstractWriter.writeHeaders()
method automatically. In this case, attempting to explicitly write the headers will result in aTextWritingException
.Defaults to
false
- Parameters:
headerWritingEnabled
- a flag to enable or disable automatic header writing.
-
getExpandIncompleteRows
public final boolean getExpandIncompleteRows()Indicates whether the writer should expand records with less columns than the number of headers. For example, if the writer is using "A,B,C" as the headers, and the user provides a row with "V1,V2", thennull
will be introduced in column C, generating the output "V1,V2,null".Defaults to
false
- Returns:
- a flag indicating whether records with less columns than the number of headers are to be expanded with nulls.
-
setExpandIncompleteRows
public final void setExpandIncompleteRows(boolean expandIncompleteRows) Defines whether the writer should expand records with less columns than the number of headers. For example, if the writer is using "A,B,C" as the headers, and the user provides a row with "V1,V2", thennull
will be introduced in column C, generating the output "V1,V2,null".Defaults to
false
- Parameters:
expandIncompleteRows
- a flag indicating whether records with less columns than the number of headers are to be expanded with nulls.
-
addConfiguration
- Overrides:
addConfiguration
in classCommonSettings<F extends Format>
-
runAutomaticConfiguration
final void runAutomaticConfiguration()- Overrides:
runAutomaticConfiguration
in classCommonSettings<F extends Format>
-
configureFromAnnotations
Configures the writer based on the annotations provided in a given class- Parameters:
beanClass
- the classes whose annotations will be processed to derive configurations for writing.
-
clone
Description copied from class:CommonSettings
Clones this configuration object to reuse user-provided settings. Properties that are specific to a given input (such as header names and selection of fields) can be reset to their defaults if theclearInputSpecificSettings
flag is set totrue
- Overrides:
clone
in classCommonSettings<F extends Format>
- Parameters:
clearInputSpecificSettings
- flag indicating whether to clear settings that are likely to be associated with a given input.- Returns:
- a copy of the configurations applied to the current instance.
-
clone
Description copied from class:CommonSettings
Clones this configuration object. Use alternativeCommonSettings.clone(boolean)
method to reset properties that are specific to a given input, such as header names and selection of fields.- Overrides:
clone
in classCommonSettings<F extends Format>
- Returns:
- a copy of all configurations applied to the current instance.
-
clearInputSpecificSettings
protected void clearInputSpecificSettings()Description copied from class:CommonSettings
Clears settings that are likely to be specific to a given input.- Overrides:
clearInputSpecificSettings
in classCommonSettings<F extends Format>
-
isColumnReorderingEnabled
public boolean isColumnReorderingEnabled()Indicates whether fields selected using the field selection methods (defined by the parent classCommonSettings
) should be reordered (defaults to false).When disabled, each written record will contain values for all columns, in the order they are sent to the writer. Fields which were not selected will not be written but and the record will contain empty values.
When enabled, each written record will contain values only for the selected columns. The values will be ordered according to the selection.
- Returns:
- true if the selected fields should be reordered when writing with field selection enabled, false otherwise
-
setColumnReorderingEnabled
public void setColumnReorderingEnabled(boolean columnReorderingEnabled) Defines whether fields selected using the field selection methods (defined by the parent classCommonSettings
) should be reordered (defaults to false).When disabled, each written record will contain values for all columns, in the order they are sent to the writer. Fields which were not selected will not be written but and the record will contain empty values.
When enabled, each written record will contain values only for the selected columns. The values will be ordered according to the selection.
- Parameters:
columnReorderingEnabled
- the flag indicating whether or not selected fields should be reordered and written by the writer
-