Interface ICsvBeanWriter

All Superinterfaces:
AutoCloseable, Closeable, Flushable, ICsvWriter
All Known Implementing Classes:
CsvBeanWriter
public interface ICsvBeanWriter extends ICsvWriter
Interface for all CSV writers writing to beans.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    write(Object source, String... nameMapping)
    Writes the fields of the object as columns of a CSV file, using the supplied name mapping to map fields to the appropriate columns.
    void
    write(Object source, String[] nameMapping, CellProcessor[] processors)
    Writes the fields of the object as columns of a CSV file, using the supplied name mapping to map fields to the appropriate columns.

    Methods inherited from interface Closeable

    close

    Methods inherited from interface Flushable

    flush

    Methods inherited from interface ICsvWriter

    getLineNumber, getRowNumber, writeComment, writeHeader

  • Method Details

    • write

      void write(Object source, String... nameMapping) throws IOException
      Writes the fields of the object as columns of a CSV file, using the supplied name mapping to map fields to the appropriate columns. toString() will be called on each element prior to writing.
      Parameters:
      source - the object (bean instance) containing the values to write
      nameMapping - an array of Strings linking the fields in the bean to their corresponding CSV columns (the array length should match the number of columns). A null entry in the array indicates that the column should be ignored (the column will be empty).
      Throws:
      IOException - if an I/O error occurred
      NullPointerException - if source or nameMapping are null
      SuperCsvException - if there was a general exception while writing
      SuperCsvReflectionException - if there was an reflection exception while mapping the values from the bean
      Since:
      1.0

    • write

      void write(Object source, String[] nameMapping, CellProcessor[] processors) throws IOException
      Writes the fields of the object as columns of a CSV file, using the supplied name mapping to map fields to the appropriate columns. toString() will be called on each (processed) element prior to writing.
      Parameters:
      source - the object (bean instance) containing the values to write
      nameMapping - an array of Strings linking the fields in the bean to their corresponding CSV columns (the array length should match the number of columns). A null entry in the array indicates that the column should be ignored (the column will be empty).
      processors - an array of CellProcessors used to further process data before it is written (each element in the processors array corresponds with a CSV column - the number of processors should match the number of columns). A null entry indicates no further processing is required (the value returned by toString() will be written as the column value).
      Throws:
      IOException - if an I/O error occurred
      NullPointerException - if source, nameMapping or processors are null
      SuperCsvConstraintViolationException - if a CellProcessor constraint failed
      SuperCsvException - if there was a general exception while writing/processing
      SuperCsvReflectionException - if there was an reflection exception while mapping the values from the bean
      Since:
      1.29