com.opencsv.bean.concurrent

Class LineExecutor<T>

java.lang.Object

java.util.concurrent.AbstractExecutorService

java.util.concurrent.ThreadPoolExecutor

com.opencsv.bean.concurrent.LineExecutor<T>

Type Parameters:

T - The type of the bean being converted to

All Implemented Interfaces:

Executor, ExecutorService, Spliterator<T>

public class LineExecutor<T>
extends ThreadPoolExecutor

A specific derivative of IntolerantThreadPoolExecutor intended for submitting lines of input to be converted to beans.

Since:

5.0

Author:

Andrew Rucker Jones

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ThreadPoolExecutor

ThreadPoolExecutor.AbortPolicy, ThreadPoolExecutor.CallerRunsPolicy, ThreadPoolExecutor.DiscardOldestPolicy, ThreadPoolExecutor.DiscardPolicy

Nested classes/interfaces inherited from interface java.util.Spliterator

Spliterator.OfDouble, Spliterator.OfInt, Spliterator.OfLong, Spliterator.OfPrimitive<T,T_CONS,T_SPLITR extends Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>

Field Summary

Fields

Modifier and Type	Field and Description
protected com.opencsv.bean.concurrent.AccumulateCsvResults<T>	accumulateThread A separate thread that accumulates and orders results.
protected Locale	errorLocale The locale for error messages.
protected SortedSet<Long>	expectedRecords A list of the ordinals of data records still to be expected by the accumulator.
protected BlockingQueue<OrderedObject<T>>	resultQueue A queue of the beans created.
protected BlockingQueue<OrderedObject<CsvException>>	thrownExceptionsQueue A queue of exceptions thrown by threads during processing.

Fields inherited from interface java.util.Spliterator

CONCURRENT, DISTINCT, IMMUTABLE, NONNULL, ORDERED, SIZED, SORTED, SUBSIZED

Constructor Summary

Constructors

Constructor and Description
LineExecutor(boolean orderedResults, Locale errorLocale, CompleteFileReader<T> completeFileReader) The only constructor available for this class.

Method Summary

Modifier and Type	Method and Description
protected void	afterExecute(Runnable r, Throwable t) Shuts the Executor down if the thread ended in an exception.
int	characteristics()
protected void	checkExceptions() Checks whether exceptions are available that should halt processing.
void	complete() Sends a signal to the Executor that it should shut down once all threads have completed.
long	estimateSize()
List<CsvException>	getCapturedExceptions() Returns exceptions captured during the conversion process if the conversion process was set not to propagate these errors up the call stack.
Throwable	getTerminalException() If an unrecoverable exception was thrown during processing, it can be retrieved here.
void	prepare() Prepares this Executor to receive jobs.
List<Runnable>	shutdownNow()
void	submitLine(long lineNumber, MappingStrategy<? extends T> mapper, CsvToBeanFilter filter, List<BeanVerifier<T>> verifiers, String[] line, CsvExceptionHandler exceptionHandler) Submit one record for conversion to a bean.
boolean	tryAdvance(Consumer<? super T> action)
Spliterator<T>	trySplit()

Methods inherited from class java.util.concurrent.ThreadPoolExecutor

allowCoreThreadTimeOut, allowsCoreThreadTimeOut, awaitTermination, beforeExecute, execute, finalize, getActiveCount, getCompletedTaskCount, getCorePoolSize, getKeepAliveTime, getLargestPoolSize, getMaximumPoolSize, getPoolSize, getQueue, getRejectedExecutionHandler, getTaskCount, getThreadFactory, isShutdown, isTerminated, isTerminating, prestartAllCoreThreads, prestartCoreThread, purge, remove, setCorePoolSize, setKeepAliveTime, setMaximumPoolSize, setRejectedExecutionHandler, setThreadFactory, shutdown, terminated, toString

Methods inherited from class java.util.concurrent.AbstractExecutorService

invokeAll, invokeAll, invokeAny, invokeAny, newTaskFor, newTaskFor, submit, submit, submit

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Spliterator

forEachRemaining, getComparator, getExactSizeIfKnown, hasCharacteristics

Field Detail

resultQueue

protected final BlockingQueue<OrderedObject<T>> resultQueue

A queue of the beans created.

thrownExceptionsQueue

protected final BlockingQueue<OrderedObject<CsvException>> thrownExceptionsQueue

A queue of exceptions thrown by threads during processing.

accumulateThread

protected com.opencsv.bean.concurrent.AccumulateCsvResults<T> accumulateThread

A separate thread that accumulates and orders results.

expectedRecords

protected final SortedSet<Long> expectedRecords

A list of the ordinals of data records still to be expected by the accumulator.

errorLocale

protected final Locale errorLocale

The locale for error messages.

Constructor Detail

LineExecutor

public LineExecutor(boolean orderedResults,
                    Locale errorLocale,
                    CompleteFileReader<T> completeFileReader)

The only constructor available for this class.

Parameters:

orderedResults - Whether order should be preserved in the results

errorLocale - The locale to use for error messages

completeFileReader - The thread that reads lines of input and feeds the results to this Executor

Method Detail

prepare

public void prepare()

Prepares this Executor to receive jobs.

checkExceptions

protected void checkExceptions()

Checks whether exceptions are available that should halt processing. This is the case with unrecoverable errors, such as parsing the input, or if exceptions in conversion should be thrown by request of the user.

submitLine

public void submitLine(long lineNumber,
                       MappingStrategy<? extends T> mapper,
                       CsvToBeanFilter filter,
                       List<BeanVerifier<T>> verifiers,
                       String[] line,
                       CsvExceptionHandler exceptionHandler)

Submit one record for conversion to a bean.

Parameters:

lineNumber - Which record in the input file is being processed

mapper - The mapping strategy to be used

filter - A filter to remove beans from the running, if necessary. May be null.

verifiers - The list of verifiers to run on beans after creation

line - The line of input to be transformed into a bean

exceptionHandler - The handler for exceptions thrown during record processing

complete

public void complete()
              throws InterruptedException

Sends a signal to the Executor that it should shut down once all threads have completed.

Throws:

InterruptedException - If the current thread is interrupted while waiting. Shouldn't be thrown, since the Executor waits indefinitely for all threads to end.

RejectedExecutionException - If an exception during processing forced this Executor to shut down.

getCapturedExceptions

public List<CsvException> getCapturedExceptions()

Returns exceptions captured during the conversion process if the conversion process was set not to propagate these errors up the call stack. The call is nondestructive.

Returns:

All exceptions captured

shutdownNow

public List<Runnable> shutdownNow()

Specified by:

shutdownNow in interface ExecutorService

Overrides:

shutdownNow in class ThreadPoolExecutor

afterExecute

protected void afterExecute(Runnable r,
                            Throwable t)

Shuts the Executor down if the thread ended in an exception.

Overrides:

afterExecute in class ThreadPoolExecutor

Parameters:

r -

t -

getTerminalException

public Throwable getTerminalException()

If an unrecoverable exception was thrown during processing, it can be retrieved here.

Returns:

The exception that halted one of the threads, which caused the executor to shut itself down

tryAdvance

public boolean tryAdvance(Consumer<? super T> action)

Specified by:

tryAdvance in interface Spliterator<T>

trySplit

public Spliterator<T> trySplit()

Specified by:

trySplit in interface Spliterator<T>

estimateSize

public long estimateSize()

Specified by:

estimateSize in interface Spliterator<T>

characteristics

public int characteristics()

Specified by:

characteristics in interface Spliterator<T>