Modifier and Type	Class and Description
private class	CsvToBean.CsvToBeanIterator A private inner class for implementing an iterator for the input data.

Modifier and Type	Field and Description
private final List<CsvException>	capturedExceptions A list of all exceptions during parsing and mapping of the input.
private CSVReader	csvReader The reader this class will use to access the data to be read.
private Locale	errorLocale The errorLocale for error messages.
private CsvExceptionHandler	exceptionHandler Determines how exceptions thrown during processing will be handled.
private LineExecutor<T>	executor The `java.util.concurrent.ExecutorService` for parallel processing of beans.
private CsvToBeanFilter	filter The filter this class will use on the beans it reads.
private boolean	ignoreEmptyLines When an empty line is encountered (not part of the data) then it is ignored.
private MappingStrategy<? extends T>	mappingStrategy The mapping strategy to be used by this CsvToBean.
private boolean	orderedResults Determines whether resulting data sets have to be in the same order as the input.
private List<BeanVerifier<T>>	verifiers All verifiers that should be run on beans after creation but before returning them to the caller.

Access	Constructor and Description
public	CsvToBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
public List<CsvException>	Returns: The list of exceptions captured while processing the input file getCapturedExceptions() Returns the list of all exceptions that would have been thrown during the import, but were queued by the exception handler.
pack-priv CsvExceptionHandler	Returns: CsvExceptionHandler used by the CsvToBean object. getExceptionHandler() Package scope method currently used by the CsvToBeanBuilderTest
public Iterator<T>	Returns: An iterator over the beans created from the input iterator() Implements java.lang.Iterable.iterator. The iterator returned by this method takes one line of input at a time and returns one bean at a time.
public List<T>	Returns: A list of populated beans based on the input parse() Parses the input based on parameters already set through other methods.
private void	prepareToReadInput()
public void	setCsvReader(CSVReader Reader for input csvReader) Sets the reader to be used to read in the information from the CSV input.
public void	setErrorLocale(Locale Locale for error messages. If null, the default locale is used. errorLocale) Sets the locale for error messages.
public void	setExceptionHandler(CsvExceptionHandler The exception handler to be used. If `null`, this method does nothing. handler) Sets the handler for recoverable exceptions raised during processing of records.
public void	setFilter(CsvToBeanFilter A class that filters the input lines filter) Sets a filter to selectively remove some lines of input before they become beans.
public void	setIgnoreEmptyLines(boolean `true` to ignore empty lines, `false` otherwise ignoreEmptyLines) Ignores any blank lines in the data that are not part of a field.
public void	setMappingStrategy(MappingStrategy<? extends T> Mapping strategy to convert CSV input to a bean mappingStrategy) Sets the mapping strategy to be used by this bean.
public void	setOrderedResults(boolean Whether or not the beans returned are in the same order they appeared in the input orderedResults) Sets whether or not results must be returned in the same order in which they appear in the input.
public void	setThrowExceptions(boolean Whether or not to throw exceptions during processing throwExceptions) Determines whether errors during import should be thrown or kept in a list for later retrieval via `getCapturedExceptions()`.
public void	setVerifiers(List<BeanVerifier<T>> A list of verifiers. May be `null`, in which case, no verifiers are run. verifiers) Sets the list of verifiers to be run on all beans after creation.
public Stream<T>	Returns: A stream of populated beans based on the input stream() Parses the input based on parameters already set through other methods.

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

Field Detail

capturedExceptions	back to summary
private final List<CsvException> capturedExceptions A list of all exceptions during parsing and mapping of the input.

csvReader	back to summary
private CSVReader csvReader The reader this class will use to access the data to be read.

errorLocale	back to summary
private Locale errorLocale The errorLocale for error messages.

exceptionHandler	back to summary
private CsvExceptionHandler exceptionHandler Determines how exceptions thrown during processing will be handled.

executor	back to summary
private LineExecutor<T> executor The `java.util.concurrent.ExecutorService` for parallel processing of beans.

filter	back to summary
private CsvToBeanFilter filter The filter this class will use on the beans it reads.

ignoreEmptyLines	back to summary
private boolean ignoreEmptyLines When an empty line is encountered (not part of the data) then it is ignored. By default this is `false`, which means an exception is thrown if there are required fields or the number of fields do not match the number of headers.

mappingStrategy	back to summary
private MappingStrategy<? extends T> mappingStrategy The mapping strategy to be used by this CsvToBean.

orderedResults	back to summary
private boolean orderedResults Determines whether resulting data sets have to be in the same order as the input.

verifiers	back to summary
private List<BeanVerifier<T>> verifiers All verifiers that should be run on beans after creation but before returning them to the caller.

Constructor Detail

CsvToBean	back to summary
public CsvToBean() Default constructor.

Method Detail

getCapturedExceptions back to summary

getCapturedExceptions	back to summary
public List<CsvException> getCapturedExceptions() Returns the list of all exceptions that would have been thrown during the import, but were queued by the exception handler. The results returned by this method are not consistent until parsing is concluded. Returns:List<CsvException> The list of exceptions captured while processing the input file See Also `setExceptionHandler(CsvExceptionHandler)`, `setThrowExceptions(boolean)`

public List<CsvException> getCapturedExceptions()

Returns the list of all exceptions that would have been thrown during the import, but were queued by the exception handler.

The results returned by this method are not consistent until parsing is concluded.

Returns:List<CsvException>: The list of exceptions captured while processing the input file
See Also: setExceptionHandler(CsvExceptionHandler), setThrowExceptions(boolean)

getExceptionHandler	back to summary
pack-priv CsvExceptionHandler getExceptionHandler() Package scope method currently used by the CsvToBeanBuilderTest Returns:CsvExceptionHandler CsvExceptionHandler used by the CsvToBean object.

getExceptionHandler

back to summary

pack-priv CsvExceptionHandler getExceptionHandler()

Package scope method currently used by the CsvToBeanBuilderTest

Returns:CsvExceptionHandler: CsvExceptionHandler used by the CsvToBean object.

iterator back to summary

iterator	back to summary
public Iterator<T> iterator() Implements java.lang.Iterable.iterator. The iterator returned by this method takes one line of input at a time and returns one bean at a time. The advantage to this method is saving memory. The cost is the loss of parallel processing, reducing throughput. The iterator respects all aspects of `CsvToBean`, including filters and capturing exceptions. Returns:Iterator<T> An iterator over the beans created from the input Annotations @Override See Also `parse()`, `stream()`

public Iterator<T> iterator()

Implements java.lang.Iterable.iterator.

The iterator returned by this method takes one line of input at a time and returns one bean at a time.

The advantage to this method is saving memory. The cost is the loss of parallel processing, reducing throughput.

The iterator respects all aspects of CsvToBean, including filters and capturing exceptions.

Returns:Iterator<T>

An iterator over the beans created from the input

Annotations

@Override

See Also

parse(), stream()

parse back to summary

parse	back to summary
public List<T> parse() throws IllegalStateException Parses the input based on parameters already set through other methods. Returns:List<T> A list of populated beans based on the input Exceptions IllegalStateException: If either MappingStrategy or CSVReader is not specified See Also `stream()`, `iterator()`

public List<T> parse() throws IllegalStateException

Parses the input based on parameters already set through other methods.

Returns:List<T>

A list of populated beans based on the input

Exceptions

IllegalStateException:: If either MappingStrategy or CSVReader is not specified

See Also

stream(), iterator()

prepareToReadInput	back to summary
private void prepareToReadInput() throws IllegalStateException

setCsvReader	back to summary
public void setCsvReader(CSVReader csvReader) Sets the reader to be used to read in the information from the CSV input. Parameters csvReader:CSVReader Reader for input

setCsvReader

back to summary

public void setCsvReader(CSVReader csvReader)

Sets the reader to be used to read in the information from the CSV input.

Parameters

csvReader:CSVReader: Reader for input

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

setErrorLocale

back to summary

public void setErrorLocale(Locale errorLocale)

Sets the locale for error messages.

Parameters

errorLocale:Locale: Locale for error messages. If null, the default locale is used.

Since

4.0

setExceptionHandler back to summary

setExceptionHandler	back to summary
public void setExceptionHandler(CsvExceptionHandler handler) Sets the handler for recoverable exceptions raised during processing of records. If neither this method nor `setThrowExceptions(boolean)` is called, the default exception handler is `ExceptionHandlerThrow`. Please note that if both this method and `setThrowExceptions(boolean)` are called, the last call wins. Parameters handler:CsvExceptionHandler The exception handler to be used. If `null`, this method does nothing. Since 5.2

public void setExceptionHandler(CsvExceptionHandler handler)

Sets the handler for recoverable exceptions raised during processing of records.

If neither this method nor setThrowExceptions(boolean) is called, the default exception handler is ExceptionHandlerThrow.

Please note that if both this method and setThrowExceptions(boolean) are called, the last call wins.

Parameters

handler:CsvExceptionHandler: The exception handler to be used. If null, this method does nothing.

Since

5.2

setFilter	back to summary
public void setFilter(CsvToBeanFilter filter) Sets a filter to selectively remove some lines of input before they become beans. Parameters filter:CsvToBeanFilter A class that filters the input lines

setFilter

back to summary

public void setFilter(CsvToBeanFilter filter)

Sets a filter to selectively remove some lines of input before they become beans.

Parameters

filter:CsvToBeanFilter: A class that filters the input lines

setIgnoreEmptyLines back to summary

setIgnoreEmptyLines	back to summary
public void setIgnoreEmptyLines(boolean ignoreEmptyLines) Ignores any blank lines in the data that are not part of a field. Parameters ignoreEmptyLines:boolean `true` to ignore empty lines, `false` otherwise

public void setIgnoreEmptyLines(boolean ignoreEmptyLines)

Ignores any blank lines in the data that are not part of a field.

Parameters

ignoreEmptyLines:boolean: true to ignore empty lines, false otherwise

setMappingStrategy	back to summary
public void setMappingStrategy(MappingStrategy<? extends T> mappingStrategy) Sets the mapping strategy to be used by this bean. Parameters mappingStrategy:MappingStrategy<? extends T> Mapping strategy to convert CSV input to a bean

setMappingStrategy

back to summary

public void setMappingStrategy(MappingStrategy<? extends T> mappingStrategy)

Sets the mapping strategy to be used by this bean.

Parameters

mappingStrategy:MappingStrategy<? extends T>: Mapping strategy to convert CSV input to a bean

setOrderedResults back to summary

setOrderedResults	back to summary
public void setOrderedResults(boolean orderedResults) Sets whether or not results must be returned in the same order in which they appear in the 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:boolean Whether or not the beans returned are in the same order they appeared in the input Since 4.0

public void setOrderedResults(boolean orderedResults)

Sets whether or not results must be returned in the same order in which they appear in the 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:boolean: Whether or not the beans returned are in the same order they appeared in the input

Since

4.0

setThrowExceptions back to summary

setThrowExceptions	back to summary
public void setThrowExceptions(boolean throwExceptions) Determines whether errors during import should be thrown or kept in a list for later retrieval via `getCapturedExceptions()`. This is a convenience function and is maintained for backwards compatibility. Passing in `true` is equivalent to `setExceptionHandler(new ExceptionHandlerThrow())` and `false` is equivalent to `setExceptionHandler(new ExceptionHandlerQueue())` Please note that if both this method and `setExceptionHandler(CsvExceptionHandler)` are called, the last call wins. Parameters throwExceptions:boolean Whether or not to throw exceptions during processing See Also `setExceptionHandler(CsvExceptionHandler)`

public void setThrowExceptions(boolean throwExceptions)

Determines whether errors during import should be thrown or kept in a list for later retrieval via getCapturedExceptions().

This is a convenience function and is maintained for backwards compatibility. Passing in true is equivalent to setExceptionHandler(new ExceptionHandlerThrow()) and false is equivalent to setExceptionHandler(new ExceptionHandlerQueue())

Please note that if both this method and setExceptionHandler(CsvExceptionHandler) are called, the last call wins.

Parameters

throwExceptions:boolean: Whether or not to throw exceptions during processing

setVerifiers back to summary

setVerifiers	back to summary
public void setVerifiers(List<BeanVerifier<T>> verifiers) Sets the list of verifiers to be run on all beans after creation. Parameters verifiers:List<BeanVerifier<T>> A list of verifiers. May be `null`, in which case, no verifiers are run. Since 4.4

public void setVerifiers(List<BeanVerifier<T>> verifiers)

Sets the list of verifiers to be run on all beans after creation.

Parameters

verifiers:List<BeanVerifier<T>>: A list of verifiers. May be null, in which case, no verifiers are run.

Since

4.4

stream back to summary

stream	back to summary
public Stream<T> stream() throws IllegalStateException Parses the input based on parameters already set through other methods. This method saves a marginal amount of time and storage compared to `parse()` because it avoids the intermediate storage of the results in a `java.util.List`. If you plan on further processing the results as a `java.util.stream.Stream`, use this method. Returns:Stream<T> A stream of populated beans based on the input Exceptions IllegalStateException: If either MappingStrategy or CSVReader is not specified See Also `parse()`, `iterator()`

public Stream<T> stream() throws IllegalStateException

Parses the input based on parameters already set through other methods. This method saves a marginal amount of time and storage compared to parse() because it avoids the intermediate storage of the results in a java.util.List. If you plan on further processing the results as a java.util.stream.Stream, use this method.

Returns:Stream<T>

A stream of populated beans based on the input

Exceptions

IllegalStateException:: If either MappingStrategy or CSVReader is not specified

See Also

parse(), iterator()

com.opencsv.bean back to summary

private Class CsvToBean.CsvToBeanIterator

Class Inheritance

extends Object
implements Iterator<T>

java.lang.Object
com.opencsv.bean.CsvToBean.CsvToBeanIterator

All Implemented Interfaces

java.util.Iterator

A private inner class for implementing an iterator for the input data.

Field Summary

Modifier and Type	Field and Description
private T	bean
private String[]	line
private long	lineProcessed
private final SingleLineReader	lineReader
private final BlockingQueue<OrderedObject<T>>	resultantBeansQueue
private final BlockingQueue<OrderedObject<CsvException>>	thrownExceptionsQueue

Constructor Summary

Access	Constructor and Description
pack-priv	CsvToBeanIterator()

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public T	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
private void	processException()
private void	readLineWithPossibleError()
private void	readSingleLine()
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

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

Field Detail

bean	back to summary
private T bean

line	back to summary
private String[] line

lineProcessed	back to summary
private long lineProcessed

lineReader	back to summary
private final SingleLineReader lineReader

resultantBeansQueue	back to summary
private final BlockingQueue<OrderedObject<T>> resultantBeansQueue

thrownExceptionsQueue	back to summary
private final BlockingQueue<OrderedObject<CsvException>> thrownExceptionsQueue

Constructor Detail

CsvToBeanIterator	back to summary
pack-priv CsvToBeanIterator()

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Annotations

@Override

next	back to summary
public T next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Annotations @Override

back to summary

public T next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Annotations

@Override

processException	back to summary
private void processException()

readLineWithPossibleError	back to summary
private void readLineWithPossibleError() throws IOException, CsvValidationException

readSingleLine	back to summary
private void readSingleLine()

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

public Class CsvToBean<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CsvToBean.CsvToBeanIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail