opencsv 5.12.0 · com.opencsv.bean.StatefulBeanToCsvBuilder

Modifier and Type	Field and Description
private boolean	applyQuotesToAll
private final ICSVWriter	csvWriter
private Locale	errorLocale
private char	escapechar
private CsvExceptionHandler	exceptionHandler
private final ListValuedMap<Class<?>, Field>	ignoredFields
private String	lineEnd
private MappingStrategy<T>	mappingStrategy
private boolean	orderedResults
private String	profile
private char	quotechar
private char	separator
private final Writer	writer

Access	Constructor and Description
public	StatefulBeanToCsvBuilder(Writer - the writer that will be used to output the csv version of the bean. writer) Default constructor - Being stateful the writer is required by the builder at the start and not added in later.
public	StatefulBeanToCsvBuilder(ICSVWriter - the ICSVWriter that will be used to output the csv version of the bean. icsvWriter) Being stateful the writer is required by the builder at the start and not added in later.

Method Summary

Modifier and Type	Method and Description
public StatefulBeanToCsv<T>	Returns: A new `StatefulBeanToCsv` build() Builds a StatefulBeanToCsv from the information provided, filling in default values where none have been specified.
public StatefulBeanToCsvBuilder<T>	Returns: this withApplyQuotesToAll(boolean Whether all outputs should be quoted applyQuotesToAll) Sets whether all outputs should be put in quotes.
public StatefulBeanToCsvBuilder<T>	Returns: this withErrorLocale(Locale Locale for error messages. If null, the default locale is used. errorLocale) Sets the locale to be used for all error messages.
public StatefulBeanToCsvBuilder<T>	withEscapechar(char The escape character to be used when writing a CSV file escapechar) Returns: this
public StatefulBeanToCsvBuilder<T>	Returns: `this` withExceptionHandler(CsvExceptionHandler The exception handler to be used. If `null`, this method does nothing. exceptionHandler) Sets the handler for recoverable exceptions raised during processing of records.
public StatefulBeanToCsvBuilder<T>	Returns: `this` withIgnoreField(Class<?> The class opencsv will encounter the field in during processing. In the case of inheritance, this may not be the declaring class. type, Field The field opencsv is to ignore field) Adds a `Field` to the list of fields opencsv should ignore completely.
public StatefulBeanToCsvBuilder<T>	withLineEnd(String The line ending to be used when writing a CSV file lineEnd) Returns: this
public StatefulBeanToCsvBuilder<T>	Returns: this withMappingStrategy(MappingStrategy<T> The mapping strategy to be used for write operations mappingStrategy) Sets the mapping strategy for writing beans to a CSV destination.
public StatefulBeanToCsvBuilder<T>	Returns: this withOrderedResults(boolean whether the lines written are in the same order they appeared in the input orderedResults) Sets whether results must be written in the same order in which they appear in the list of beans provided as input.
public StatefulBeanToCsvBuilder<T>	Returns: `this` withProfile(String The name of the profile to be used profile) Selects a profile for deciding which configurations to use for the bean fields.
public StatefulBeanToCsvBuilder<T>	withQuotechar(char The quote character to be used when writing a CSV file quotechar) Returns: this
public StatefulBeanToCsvBuilder<T>	withSeparator(char The field separator to be used when writing a CSV file separator) Returns: this
public StatefulBeanToCsvBuilder<T>	Returns: this withThrowExceptions(boolean Whether or not exceptions should be thrown while writing a CSV file. If not, they may be retrieved later by calling `com.opencsv.bean.StatefulBeanToCsv#getCapturedExceptions()`. throwExceptions) Sets the handler for recoverable exceptions that arise during the processing of records.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

applyQuotesToAll	back to summary
private boolean applyQuotesToAll

csvWriter	back to summary
private final ICSVWriter csvWriter

errorLocale	back to summary
private Locale errorLocale

escapechar	back to summary
private char escapechar

exceptionHandler	back to summary
private CsvExceptionHandler exceptionHandler

ignoredFields	back to summary
private final ListValuedMap<Class<?>, Field> ignoredFields

lineEnd	back to summary
private String lineEnd

mappingStrategy	back to summary
private MappingStrategy<T> mappingStrategy

orderedResults	back to summary
private boolean orderedResults

profile	back to summary
private String profile

quotechar	back to summary
private char quotechar

separator	back to summary
private char separator

writer	back to summary
private final Writer writer

StatefulBeanToCsvBuilder	back to summary
public StatefulBeanToCsvBuilder(Writer writer) Default constructor - Being stateful the writer is required by the builder at the start and not added in later. Parameters writer:Writer - the writer that will be used to output the csv version of the bean.

StatefulBeanToCsvBuilder	back to summary
public StatefulBeanToCsvBuilder(ICSVWriter icsvWriter) Being stateful the writer is required by the builder at the start and not added in later. By passing in the ICSVWriter you can create a writer with the desired ICSVParser to allow you to use the exact same parser for reading and writing. Parameters icsvWriter:ICSVWriter - the ICSVWriter that will be used to output the csv version of the bean. Since 4.2

Method Detail

build back to summary

build	back to summary
public StatefulBeanToCsv<T> build() Builds a StatefulBeanToCsv from the information provided, filling in default values where none have been specified. Returns:StatefulBeanToCsv<T> A new `StatefulBeanToCsv`

public StatefulBeanToCsv<T> build()

Builds a StatefulBeanToCsv from the information provided, filling in default values where none have been specified.

Returns:StatefulBeanToCsv<T>: A new StatefulBeanToCsv

withApplyQuotesToAll back to summary

withApplyQuotesToAll	back to summary
public StatefulBeanToCsvBuilder<T> withApplyQuotesToAll(boolean applyQuotesToAll) Sets whether all outputs should be put in quotes. Defaults to `true`. Parameters applyQuotesToAll:boolean Whether all outputs should be quoted Returns:StatefulBeanToCsvBuilder<T> this Since 4.2 See Also `com.opencsv.CSVWriter#writeNext(String[], boolean)`

public StatefulBeanToCsvBuilder<T> withApplyQuotesToAll(boolean applyQuotesToAll)

Sets whether all outputs should be put in quotes. Defaults to true.

Parameters

applyQuotesToAll:boolean: Whether all outputs should be quoted

Returns:StatefulBeanToCsvBuilder<T>

this

Since

4.2

withErrorLocale back to summary

withErrorLocale	back to summary
public StatefulBeanToCsvBuilder<T> withErrorLocale(Locale errorLocale) Sets the locale to be used for all error messages. Parameters errorLocale:Locale Locale for error messages. If null, the default locale is used. Returns:StatefulBeanToCsvBuilder<T> this Since 4.0 See Also `StatefulBeanToCsv#setErrorLocale(java.util.Locale)`

public StatefulBeanToCsvBuilder<T> withErrorLocale(Locale errorLocale)

Sets the locale to be used for all error messages.

Parameters

errorLocale:Locale: Locale for error messages. If null, the default locale is used.

Returns:StatefulBeanToCsvBuilder<T>

this

Since

4.0

withEscapechar	back to summary
public StatefulBeanToCsvBuilder<T> withEscapechar(char escapechar) Parameters escapechar:char The escape character to be used when writing a CSV file Returns:StatefulBeanToCsvBuilder<T> this See Also `com.opencsv.CSVWriter#escapechar`

withExceptionHandler back to summary

withExceptionHandler	back to summary
public StatefulBeanToCsvBuilder<T> withExceptionHandler(CsvExceptionHandler exceptionHandler) Sets the handler for recoverable exceptions raised during processing of records. If neither this method nor `withThrowExceptions(boolean)` is called, the default exception handler is `ExceptionHandlerThrow`. Please note that if both this method and `withThrowExceptions(boolean)` are called, the last call wins. Parameters exceptionHandler:CsvExceptionHandler The exception handler to be used. If `null`, this method does nothing. Returns:StatefulBeanToCsvBuilder<T> `this` Since 5.2

public StatefulBeanToCsvBuilder<T> withExceptionHandler(CsvExceptionHandler exceptionHandler)

Sets the handler for recoverable exceptions raised during processing of records.

If neither this method nor withThrowExceptions(boolean) is called, the default exception handler is ExceptionHandlerThrow.

Please note that if both this method and withThrowExceptions(boolean) are called, the last call wins.

Parameters

exceptionHandler:CsvExceptionHandler: The exception handler to be used. If null, this method does nothing.

Returns:StatefulBeanToCsvBuilder<T>

this

Since

5.2

withIgnoreField back to summary

withIgnoreField	back to summary
public StatefulBeanToCsvBuilder<T> withIgnoreField(Class<?> type, Field field) throws IllegalArgumentException Adds a `Field` to the list of fields opencsv should ignore completely. May be called as many times as necessary. Parameters type:Class<?> The class opencsv will encounter the field in during processing. In the case of inheritance, this may not be the declaring class. field:Field The field opencsv is to ignore Returns:StatefulBeanToCsvBuilder<T> `this` Exceptions IllegalArgumentException: If one of the parameters is `null` or `field` cannot be found in `type`. Since 5.0 See Also `MappingStrategy#ignoreFields(MultiValuedMap)`

public StatefulBeanToCsvBuilder<T> withIgnoreField(Class<?> type, Field field) throws IllegalArgumentException

Adds a Field to the list of fields opencsv should ignore completely.

May be called as many times as necessary.

Parameters

type:Class<?>: The class opencsv will encounter the field in during processing. In the case of inheritance, this may not be the declaring class.
field:Field: The field opencsv is to ignore

Returns:StatefulBeanToCsvBuilder<T>

this

Exceptions

IllegalArgumentException:: If one of the parameters is null or field cannot be found in type.

Since

5.0

withLineEnd	back to summary
public StatefulBeanToCsvBuilder<T> withLineEnd(String lineEnd) Parameters lineEnd:String The line ending to be used when writing a CSV file Returns:StatefulBeanToCsvBuilder<T> this See Also `com.opencsv.CSVWriter#lineEnd`

withMappingStrategy	back to summary
public StatefulBeanToCsvBuilder<T> withMappingStrategy(MappingStrategy<T> mappingStrategy) Sets the mapping strategy for writing beans to a CSV destination. If the mapping strategy is set this way, it will always be used instead of automatic determination of an appropriate mapping strategy. It is perfectly legitimate to read a CSV source, take the mapping strategy from the read operation, and pass it in to this method for a write operation. This conserves some processing time, but, more importantly, preserves header ordering. Parameters mappingStrategy:MappingStrategy<T> The mapping strategy to be used for write operations Returns:StatefulBeanToCsvBuilder<T> this

withMappingStrategy

back to summary

public StatefulBeanToCsvBuilder<T> withMappingStrategy(MappingStrategy<T> mappingStrategy)

Sets the mapping strategy for writing beans to a CSV destination.

If the mapping strategy is set this way, it will always be used instead of automatic determination of an appropriate mapping strategy.

It is perfectly legitimate to read a CSV source, take the mapping strategy from the read operation, and pass it in to this method for a write operation. This conserves some processing time, but, more importantly, preserves header ordering.

Parameters

mappingStrategy:MappingStrategy<T>: The mapping strategy to be used for write operations

Returns:StatefulBeanToCsvBuilder<T>

this

withOrderedResults back to summary

withOrderedResults	back to summary
public StatefulBeanToCsvBuilder<T> withOrderedResults(boolean orderedResults) Sets whether results must be written in the same order in which they appear in the list of beans provided as input. Parameters orderedResults:boolean whether the lines written are in the same order they appeared in the input Returns:StatefulBeanToCsvBuilder<T> this Since 4.0 See Also `StatefulBeanToCsv#setOrderedResults(boolean)`

public StatefulBeanToCsvBuilder<T> withOrderedResults(boolean orderedResults)

Sets whether results must be written in the same order in which they appear in the list of beans provided as input.

Parameters

orderedResults:boolean: whether the lines written are in the same order they appeared in the input

Returns:StatefulBeanToCsvBuilder<T>

this

Since

4.0

withProfile back to summary

withProfile	back to summary
public StatefulBeanToCsvBuilder<T> withProfile(String profile) Selects a profile for deciding which configurations to use for the bean fields. Parameters profile:String The name of the profile to be used Returns:StatefulBeanToCsvBuilder<T> `this` Since 5.4

public StatefulBeanToCsvBuilder<T> withProfile(String profile)

Selects a profile for deciding which configurations to use for the bean fields.

Parameters

profile:String: The name of the profile to be used

Returns:StatefulBeanToCsvBuilder<T>

this

Since

5.4

withQuotechar	back to summary
public StatefulBeanToCsvBuilder<T> withQuotechar(char quotechar) Parameters quotechar:char The quote character to be used when writing a CSV file Returns:StatefulBeanToCsvBuilder<T> this See Also `com.opencsv.CSVWriter#quotechar`

withSeparator	back to summary
public StatefulBeanToCsvBuilder<T> withSeparator(char separator) Parameters separator:char The field separator to be used when writing a CSV file Returns:StatefulBeanToCsvBuilder<T> this See Also `com.opencsv.CSVWriter#separator`

withThrowExceptions back to summary

withThrowExceptions	back to summary
public StatefulBeanToCsvBuilder<T> withThrowExceptions(boolean throwExceptions) Sets the handler for recoverable exceptions that arise during the processing of records. This is a convenience function and is maintained for backwards compatibility. Passing in `true` is equivalent to `withExceptionHandler(new ExceptionHandlerThrow())` and `false` is equivalent to `withExceptionHandler(new ExceptionHandlerQueue())` Please note that if both this method and `withExceptionHandler(CsvExceptionHandler)` are called, the last call wins. Parameters throwExceptions:boolean Whether or not exceptions should be thrown while writing a CSV file. If not, they may be retrieved later by calling `com.opencsv.bean.StatefulBeanToCsv#getCapturedExceptions()`. Returns:StatefulBeanToCsvBuilder<T> this See Also `withExceptionHandler(CsvExceptionHandler)`

public StatefulBeanToCsvBuilder<T> withThrowExceptions(boolean throwExceptions)

Sets the handler for recoverable exceptions that arise during the processing of records.

This is a convenience function and is maintained for backwards compatibility. Passing in true is equivalent to withExceptionHandler(new ExceptionHandlerThrow()) and false is equivalent to withExceptionHandler(new ExceptionHandlerQueue())

Please note that if both this method and withExceptionHandler(CsvExceptionHandler) are called, the last call wins.

Parameters

throwExceptions:boolean: Whether or not exceptions should be thrown while writing a CSV file. If not, they may be retrieved later by calling com.opencsv.bean.StatefulBeanToCsv#getCapturedExceptions().

Returns:StatefulBeanToCsvBuilder<T>

this

public Class StatefulBeanToCsvBuilder<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail