Class StatefulBeanToCsv<T>

java.lang.Object
com.opencsv.bean.StatefulBeanToCsv<T>
Type Parameters:
T - Type of the bean to be written
public class StatefulBeanToCsv<T> extends Object
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
Author:
Andrew Rucker Jones
See Also:
  • OpencsvUtils.determineMappingStrategy(java.lang.Class, java.util.Locale, java.lang.String)

  • Constructor Details

    • 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 a StatefulBeanToCsv with a user-supplied ICSVWriter class.
      Parameters:
      mappingStrategy - The mapping strategy to use when writing a CSV file
      exceptionHandler - Determines the exception handling behavior
      applyQuotesToAll - Whether all output fields should be quoted
      csvWriter - An user-supplied ICSVWriter for writing beans to a CSV output
      ignoredFields - The fields to ignore during processing. May be null.
      profile - The profile to use when configuring how to interpret bean fields

  • Method Details

    • write

      public void write(T bean) throws CsvDataTypeMismatchException, CsvRequiredFieldEmptyException
      Writes a bean out to the Writer 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 written
      CsvRequiredFieldEmptyException - If a field is marked as required, but the source is null

    • write

      public void write(List<T> beans) throws CsvDataTypeMismatchException, CsvRequiredFieldEmptyException
      Writes a list of beans out to the Writer 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 written
      CsvRequiredFieldEmptyException - 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 the Writer 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 written
      CsvRequiredFieldEmptyException - 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 the Writer 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 written
      CsvRequiredFieldEmptyException - 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 setting orderedResults to false. 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 public boolean 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

      public List<CsvException> 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) or write(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

      public void setErrorLocale(Locale errorLocale)
      Sets the locale for all error messages.
      Parameters:
      errorLocale - Locale for error messages. If null, the default locale is used.
      Since:
      4.0