Package com.opencsv.bean
Class StatefulBeanToCsv<T>
java.lang.Object
com.opencsv.bean.StatefulBeanToCsv<T>
- Type Parameters:
T
- Type of the bean to be written
This class writes beans out in CSV format to a
Writer
,
keeping state information and making an intelligent guess at the mapping
strategy to be applied.
This class implements multi-threading on writing more than one bean, so there should be no need to use it across threads in an application. As such, it is not thread-safe.
- Since:
- 3.9
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final boolean
private List
<CsvException> private ICSVWriter
private Locale
private final char
private final CsvExceptionHandler
private BeanExecutor
<T> private boolean
private final String
private int
The beans being written are counted in the order they are written.private MappingStrategy
<T> private static final char
private boolean
private final String
private final char
private final char
private final Writer
-
Constructor Summary
ConstructorsConstructorDescriptionStatefulBeanToCsv
(char escapechar, String lineEnd, MappingStrategy<T> mappingStrategy, char quotechar, char separator, CsvExceptionHandler exceptionHandler, Writer writer, boolean applyQuotesToAll, org.apache.commons.collections4.MultiValuedMap<Class<?>, Field> ignoredFields, String profile) Constructor used when supplying a Writer instead of a CsvWriter class.StatefulBeanToCsv
(MappingStrategy<T> mappingStrategy, CsvExceptionHandler exceptionHandler, boolean applyQuotesToAll, ICSVWriter csvWriter, org.apache.commons.collections4.MultiValuedMap<Class<?>, Field> ignoredFields, String profile) Constructor used to allow building of aStatefulBeanToCsv
with a user-suppliedICSVWriter
class. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
beforeFirstWrite
(T bean) Custodial tasks that must be performed before beans are written to a CSV destination for the first time.Any exceptions captured during writing of beans to a CSV destination can be retrieved through this method.boolean
Deprecated.There is simply no need for this method.void
setErrorLocale
(Locale errorLocale) Sets the locale for all error messages.void
setOrderedResults
(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.private void
submitAllLines
(Iterator<T> beans) void
Writes an iterator of beans out to theWriter
provided to the constructor.void
Writes a list of beans out to theWriter
provided to the constructor.void
Writes a stream of beans out to theWriter
provided to the constructor.void
Writes a bean out to theWriter
provided to the constructor.
-
Field Details
-
NO_CHARACTER
private static final char NO_CHARACTER- See Also:
-
lineNumber
private int lineNumberThe beans being written are counted in the order they are written. -
separator
private final char separator -
quotechar
private final char quotechar -
escapechar
private final char escapechar -
lineEnd
-
headerWritten
private boolean headerWritten -
mappingStrategy
-
writer
-
csvwriter
-
exceptionHandler
-
capturedExceptions
-
orderedResults
private boolean orderedResults -
executor
-
errorLocale
-
applyQuotesToAll
private final boolean applyQuotesToAll -
ignoredFields
-
profile
-
-
Constructor Details
-
StatefulBeanToCsv
StatefulBeanToCsv(char escapechar, String lineEnd, MappingStrategy<T> mappingStrategy, char quotechar, char separator, CsvExceptionHandler exceptionHandler, Writer writer, boolean applyQuotesToAll, org.apache.commons.collections4.MultiValuedMap<Class<?>, Field> ignoredFields, String profile) Constructor used when supplying a Writer instead of a CsvWriter class. It is defined as package protected to ensure thatStatefulBeanToCsvBuilder
is always used.- Parameters:
escapechar
- The escape character to use when writing a CSV filelineEnd
- The line ending to use when writing a CSV filemappingStrategy
- The mapping strategy to use when writing a CSV filequotechar
- The quote character to use when writing a CSV fileseparator
- The field separator to use when writing a CSV fileexceptionHandler
- Determines the exception handling behaviorwriter
- AWriter
for writing the beans as a CSV toapplyQuotesToAll
- Whether all output fields should be quotedignoredFields
- The fields to ignore during processing. May benull
.profile
- The profile to use when configuring how to interpret bean fields
-
StatefulBeanToCsv
public StatefulBeanToCsv(MappingStrategy<T> mappingStrategy, CsvExceptionHandler exceptionHandler, boolean applyQuotesToAll, ICSVWriter csvWriter, org.apache.commons.collections4.MultiValuedMap<Class<?>, Field> ignoredFields, String profile) Constructor used to allow building of aStatefulBeanToCsv
with a user-suppliedICSVWriter
class.- Parameters:
mappingStrategy
- The mapping strategy to use when writing a CSV fileexceptionHandler
- Determines the exception handling behaviorapplyQuotesToAll
- Whether all output fields should be quotedcsvWriter
- An user-suppliedICSVWriter
for writing beans to a CSV outputignoredFields
- The fields to ignore during processing. May benull
.profile
- The profile to use when configuring how to interpret bean fields
-
-
Method Details
-
beforeFirstWrite
Custodial tasks that must be performed before beans are written to a CSV destination for the first time.- Parameters:
bean
- Any bean to be written. Used to determine the mapping strategy automatically. The bean itself is not written to the output by this method.- Throws:
CsvRequiredFieldEmptyException
- If a required header is missing while attempting to write. Since every other header is hard-wired through the bean fields and their associated annotations, this can only happen with multi-valued fields.
-
write
Writes a bean out to theWriter
provided to the constructor.- Parameters:
bean
- A bean to be written to a CSV destination- Throws:
CsvDataTypeMismatchException
- If a field of the bean is annotated improperly or an unsupported data type is supposed to be writtenCsvRequiredFieldEmptyException
- If a field is marked as required, but the source is null
-
submitAllLines
- Throws:
InterruptedException
-
write
public void write(List<T> beans) throws CsvDataTypeMismatchException, CsvRequiredFieldEmptyException Writes a list of beans out to theWriter
provided to the constructor.- Parameters:
beans
- A list of beans to be written to a CSV destination- Throws:
CsvDataTypeMismatchException
- If a field of the beans is annotated improperly or an unsupported data type is supposed to be writtenCsvRequiredFieldEmptyException
- If a field is marked as required, but the source is null
-
write
public void write(Iterator<T> iBeans) throws CsvDataTypeMismatchException, CsvRequiredFieldEmptyException Writes an iterator of beans out to theWriter
provided to the constructor.- Parameters:
iBeans
- An iterator of beans to be written to a CSV destination- Throws:
CsvDataTypeMismatchException
- If a field of the beans is annotated improperly or an unsupported data type is supposed to be writtenCsvRequiredFieldEmptyException
- If a field is marked as required, but the source is null
-
write
public void write(Stream<T> beans) throws CsvDataTypeMismatchException, CsvRequiredFieldEmptyException Writes a stream of beans out to theWriter
provided to the constructor.- Parameters:
beans
- A stream of beans to be written to a CSV destination- Throws:
CsvDataTypeMismatchException
- If a field of the beans is annotated improperly or an unsupported data type is supposed to be writtenCsvRequiredFieldEmptyException
- If a field is marked as required, but the source is null
-
setOrderedResults
public void setOrderedResults(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. The default is that order is preserved. If your data do not need to be ordered, you can get a slight performance boost by settingorderedResults
tofalse
. The lack of ordering then also applies to any captured exceptions, if you have chosen not to have exceptions thrown.- Parameters:
orderedResults
- Whether or not the lines written are in the same order they appeared in the input- Since:
- 4.0
-
isThrowExceptions
Deprecated.There is simply no need for this method.- Returns:
- Whether or not exceptions are thrown. If they are not thrown,
they are captured and returned later via
getCapturedExceptions()
.
-
getCapturedExceptions
Any exceptions captured during writing of beans to a CSV destination can be retrieved through this method.Reads from the list are destructive! Calling this method will clear the list of captured exceptions. However, calling
write(java.util.List)
orwrite(java.lang.Object)
multiple times with no intervening call to this method will not clear the list of captured exceptions, but rather add to it if further exceptions are thrown.- Returns:
- A list of exceptions that would have been thrown during any and all read operations since the last call to this method
-
setErrorLocale
Sets the locale for all error messages.- Parameters:
errorLocale
- Locale for error messages. If null, the default locale is used.- Since:
- 4.0
-