com.opencsv.bean

Class StatefulBeanToCsvBuilder<T>

java.lang.Object

com.opencsv.bean.StatefulBeanToCsvBuilder<T>

Type Parameters:

T - The type of the beans being written

public class StatefulBeanToCsvBuilder<T>
extends Object

This is a builder for StatefulBeanToCsv, allowing one to set all parameters necessary for writing a CSV file.

Since:

3.9

Author:

Andrew Rucker Jones

Constructor Summary

Constructors

Constructor and Description
StatefulBeanToCsvBuilder(ICSVWriter icsvWriter) Being stateful the writer is required by the builder at the start and not added in later.
StatefulBeanToCsvBuilder(Writer writer) Default constructor - 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
StatefulBeanToCsv<T>	build() Builds a StatefulBeanToCsv from the information provided, filling in default values where none have been specified.
StatefulBeanToCsvBuilder<T>	withApplyQuotesToAll(boolean applyQuotesToAll) Sets whether all outputs should be put in quotes.
StatefulBeanToCsvBuilder<T>	withErrorLocale(Locale errorLocale) Sets the locale to be used for all error messages.
StatefulBeanToCsvBuilder<T>	withEscapechar(char escapechar)
StatefulBeanToCsvBuilder<T>	withExceptionHandler(CsvExceptionHandler exceptionHandler) Sets the handler for recoverable exceptions raised during processing of records.
StatefulBeanToCsvBuilder<T>	withIgnoreField(Class<?> type, Field field) Adds a Field to the list of fields opencsv should ignore completely.
StatefulBeanToCsvBuilder<T>	withLineEnd(String lineEnd)
StatefulBeanToCsvBuilder<T>	withMappingStrategy(MappingStrategy<T> mappingStrategy) Sets the mapping strategy for writing beans to a CSV destination.
StatefulBeanToCsvBuilder<T>	withOrderedResults(boolean orderedResults) Sets whether or not results must be written in the same order in which they appear in the list of beans provided as input.
StatefulBeanToCsvBuilder<T>	withProfile(String profile) Selects a profile for deciding which configurations to use for the bean fields.
StatefulBeanToCsvBuilder<T>	withQuotechar(char quotechar)
StatefulBeanToCsvBuilder<T>	withSeparator(char separator)
StatefulBeanToCsvBuilder<T>	withThrowExceptions(boolean throwExceptions) Sets the handler for recoverable exceptions that arise during the processing of records.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatefulBeanToCsvBuilder

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 - - the writer that will be used to output the csv version of the bean.

StatefulBeanToCsvBuilder

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 - - the ICSVWriter that will be used to output the csv version of the bean.

Since:

4.2

Method Detail

withMappingStrategy

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 - The mapping strategy to be used for write operations

Returns:

this

withSeparator

public StatefulBeanToCsvBuilder<T> withSeparator(char separator)

Parameters:

separator - The field separator to be used when writing a CSV file

Returns:

this

See Also:

CSVWriter.separator

withQuotechar

public StatefulBeanToCsvBuilder<T> withQuotechar(char quotechar)

Parameters:

quotechar - The quote character to be used when writing a CSV file

Returns:

this

See Also:

CSVWriter.quotechar

withEscapechar

public StatefulBeanToCsvBuilder<T> withEscapechar(char escapechar)

Parameters:

escapechar - The escape character to be used when writing a CSV file

Returns:

this

See Also:

CSVWriter.escapechar

withLineEnd

public StatefulBeanToCsvBuilder<T> withLineEnd(String lineEnd)

Parameters:

lineEnd - The line ending to be used when writing a CSV file

Returns:

this

See Also:

AbstractCSVWriter.lineEnd

withThrowExceptions

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 - Whether or not exceptions should be thrown while writing a CSV file. If not, they may be retrieved later by calling StatefulBeanToCsv.getCapturedExceptions().

Returns:

this

See Also:

withExceptionHandler(CsvExceptionHandler)

withExceptionHandler

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 - The exception handler to be used. If null, this method does nothing.

Returns:

this

Since:

5.2

withOrderedResults

public StatefulBeanToCsvBuilder<T> withOrderedResults(boolean orderedResults)

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

Parameters:

orderedResults - Whether or not the lines written are in the same order they appeared in the input

Returns:

this

Since:

4.0

See Also:

StatefulBeanToCsv.setOrderedResults(boolean)

withErrorLocale

public StatefulBeanToCsvBuilder<T> withErrorLocale(Locale errorLocale)

Sets the locale to be used for all error messages.

Parameters:

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

Returns:

this

Since:

4.0

See Also:

StatefulBeanToCsv.setErrorLocale(java.util.Locale)

withApplyQuotesToAll

public StatefulBeanToCsvBuilder<T> withApplyQuotesToAll(boolean applyQuotesToAll)

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

Parameters:

applyQuotesToAll - Whether all outputs should be quoted

Returns:

this

Since:

4.2

See Also:

AbstractCSVWriter.writeNext(String[], boolean)

withIgnoreField

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 - The class opencsv will encounter the field in during processing. In the case of inheritance, this may not be the declaring class.

field - The field opencsv is to ignore

Returns:

this

Throws:

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

Since:

5.0

See Also:

MappingStrategy.ignoreFields(MultiValuedMap)

withProfile

public StatefulBeanToCsvBuilder<T> withProfile(String profile)

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

Parameters:

profile - The name of the profile to be used

Returns:

this

Since:

5.4

build

public StatefulBeanToCsv<T> build()

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

Returns:

A new StatefulBeanToCsv