opencsv 5.12.0 · com.opencsv.bean.exceptionhandler.ExceptionHandlerQueueThenThrowAfter

An exception handler that queues the first x exceptions, then throws any further exceptions.

Note

when testing this on systems with a high number of cores/threads under load we noted discrepancies between the number of exceptions counted and the number exceptions queued. If it is actually important to see the exceptions thrown then we would heavily recommend you use the single threaded iterator() in CsvToBean and collecting the exceptions yourself.

Modifier and Type	Field and Description
private final AtomicInteger	count
private final int	maxExceptions

Constructor Summary

Access	Constructor and Description
public	ExceptionHandlerQueueThenThrowAfter(int The number of exceptions that will be queued. Any exception handled after this limit will be thrown. maxExceptions) Creates an instance.

Method Summary

Modifier and Type	Method and Description
public CsvException	handleException(CsvException e) Implements com.opencsv.bean.exceptionhandler.CsvExceptionHandler.handleException. Determines how opencsv will handle exceptions that crop up during bean creation or writing.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

count	back to summary
private final AtomicInteger count

maxExceptions	back to summary
private final int maxExceptions

Constructor Detail

ExceptionHandlerQueueThenThrowAfter	back to summary
public ExceptionHandlerQueueThenThrowAfter(int maxExceptions) Creates an instance. Parameters maxExceptions:int The number of exceptions that will be queued. Any exception handled after this limit will be thrown.

ExceptionHandlerQueueThenThrowAfter

back to summary

public ExceptionHandlerQueueThenThrowAfter(int maxExceptions)

Creates an instance.

Parameters

maxExceptions:int: The number of exceptions that will be queued. Any exception handled after this limit will be thrown.

Method Detail

handleException back to summary

handleException	back to summary
public CsvException handleException(CsvException e) throws CsvException Implements com.opencsv.bean.exceptionhandler.CsvExceptionHandler.handleException. Doc from com.opencsv.bean.exceptionhandler.CsvExceptionHandler.handleException. Determines how opencsv will handle exceptions that crop up during bean creation or writing. There are three ways of dealing with an exception: Ignore the exception. In this case, return `null`. Queue the exception. In this case, return either the original exception thrown, or a new exception that meets your needs better. 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. Annotations @Override Exceptions CsvException: If a halt to all processing is desired

public CsvException handleException(CsvException e) throws CsvException

Implements com.opencsv.bean.exceptionhandler.CsvExceptionHandler.handleException.

Doc from com.opencsv.bean.exceptionhandler.CsvExceptionHandler.handleException.

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

Ignore the exception. In this case, return null.
Queue the exception. In this case, return either the original exception thrown, or a new exception that meets your needs better.
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.

Annotations

@Override

Exceptions

CsvException:: If a halt to all processing is desired

public final Class ExceptionHandlerQueueThenThrowAfter