Top Description Methods
com.opencsv.bean.exceptionhandler

public Interface CsvExceptionHandler

Known Direct Implementers
com.opencsv.bean.exceptionhandler.ExceptionHandlerIgnore, com.opencsv.bean.exceptionhandler.ExceptionHandlerIgnoreThenThrowAfter, com.opencsv.bean.exceptionhandler.ExceptionHandlerQueue, com.opencsv.bean.exceptionhandler.ExceptionHandlerQueueThenThrowAfter, com.opencsv.bean.exceptionhandler.ExceptionHandlerThrow
Annotations
@FunctionalInterface
Imports
com.opencsv.bean.CsvToBean, .StatefulBeanToCsv, com.opencsv.exceptions.CsvException

This interface defines a generic way of dealing with exceptions thrown during the creation of beans or their conversion to CSV output.
Author
Andrew Rucker Jones
Since
5.2

Method Summary

Modifier and TypeMethod and Description
public CsvException

Returns:

The exception to be queued, or null if the exception should be ignored
handleException
(CsvException
The exception that was thrown
e
)

Determines how opencsv will handle exceptions that crop up during bean creation or writing.

Method Detail

handleExceptionback to summary
public CsvException handleException(CsvException e) throws CsvException

Determines how opencsv will handle exceptions that crop up during bean creation or writing. There are three ways of dealing with an exception:

  1. Ignore the exception. In this case, return null.
  2. Queue the exception. In this case, return either the original exception thrown, or a new exception that meets your needs better.
  3. Halt processing by throwing the exception. In this case, throw the exception or a new exception that meets your needs better.

Please be cautioned: Due to the multi-threaded nature of opencsv's conversion routines, there is no guarantee that the exception thrown, if your chosen error handler throws exceptions, is the error in the input that would have caused the exception to be thrown if the input were processed in strict sequential order. That is, if there are four errors in the input and your error handler queues the first three but throws the fourth, the exception thrown might relate to any of the four errors in the input.

If your exception handler queues a certain number of exceptions before throwing one, opencsv makes a best-faith effort to make sure all of the exceptions marked for queueing are actually available via CsvToBean#getCapturedExceptions() or StatefulBeanToCsv#getCapturedExceptions() after processing, but there are no absolute guarantees.

This method must be thread-safe.

Parameters
e:CsvException

The exception that was thrown

Returns:CsvException

The exception to be queued, or null if the exception should be ignored

Exceptions
CsvException:
If a halt to all processing is desired