Class CSVReaderHeaderAwareBuilder

java.lang.Object

com.opencsv.CSVReaderBaseBuilder<CSVReaderHeaderAware>

com.opencsv.CSVReaderHeaderAwareBuilder

public class CSVReaderHeaderAwareBuilder
extends CSVReaderBaseBuilder<CSVReaderHeaderAware>

Builder for CSVReaderHeaderAware.

Since:

4.2

Field Summary

Fields inherited from class CSVReaderBaseBuilder

errorLocale, icsvParser, keepCR, lineValidatorAggregator, multilineLimit, nullFieldIndicator, reader, rowProcessor, rowValidatorAggregator, skipLines, verifyReader

Constructor Summary

Constructors

Constructor	Description
CSVReaderHeaderAwareBuilder(Reader reader)	Sets the reader to an underlying CSV source.

Method Summary

Modifier and Type	Method	Description
CSVReaderHeaderAware	build()	Creates the CSVReaderHeaderAware.
CSVReaderHeaderAwareBuilder	withCSVParser(ICSVParser icsvParser)	Sets the parser to use to parse the input.
CSVReaderHeaderAwareBuilder	withErrorLocale(Locale errorLocale)	Sets the locale for all error messages.
CSVReaderHeaderAwareBuilder	withFieldAsNull(CSVReaderNullFieldIndicator indicator)	Checks to see if it should treat a field with two separators, two quotes, or both as a null field.
CSVReaderHeaderAwareBuilder	withKeepCarriageReturn(boolean keepCR)	Sets if the reader will keep or discard carriage returns.
CSVReaderHeaderAwareBuilder	withLineValidator(LineValidator lineValidator)	Adds a LineValidator to the CSVReaderHeaderAware.
CSVReaderHeaderAwareBuilder	withMultilineLimit(int multilineLimit)	Sets the maximum number of lines allowed in a multiline record.
CSVReaderHeaderAwareBuilder	withRowProcessor(RowProcessor rowProcessor)	Adds a RowProcessor to the CSVReaderHeaderAware.
CSVReaderHeaderAwareBuilder	withRowValidator(RowValidator rowValidator)	Adds a RowValidator to the CSVReaderHeaderAware.
CSVReaderHeaderAwareBuilder	withSkipLines(int skipLines)	Sets the number of lines to skip before reading.
CSVReaderHeaderAwareBuilder	withVerifyReader(boolean verifyReader)	Checks to see if the CSVReaderHeaderAware should verify the reader state before reads or not.

Methods inherited from class CSVReaderBaseBuilder

getCsvParser, getErrorLocale, getLineValidatorAggregator, getMultilineLimit, getOrCreateCsvParser, getReader, getRowValidatorAggregator, getSkipLines, isVerifyReader, keepCarriageReturn

Methods inherited from class Object

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

Constructor Details

CSVReaderHeaderAwareBuilder

public CSVReaderHeaderAwareBuilder(Reader reader)

Sets the reader to an underlying CSV source.

Parameters:

reader - The reader to an underlying CSV source.

Method Details

withSkipLines

public CSVReaderHeaderAwareBuilder withSkipLines(int skipLines)

Sets the number of lines to skip before reading.

Parameters:

skipLines - The number of lines to skip before reading.

Returns:

this

withCSVParser

public CSVReaderHeaderAwareBuilder withCSVParser(ICSVParser icsvParser)

Sets the parser to use to parse the input.

Parameters:

icsvParser - The parser to use to parse the input.

Returns:

this

withKeepCarriageReturn

public CSVReaderHeaderAwareBuilder withKeepCarriageReturn(boolean keepCR)

Sets if the reader will keep or discard carriage returns.

Parameters:

keepCR - True to keep carriage returns, false to discard.

Returns:

this

withVerifyReader

public CSVReaderHeaderAwareBuilder withVerifyReader(boolean verifyReader)

Checks to see if the CSVReaderHeaderAware should verify the reader state before reads or not.

This should be set to false if you are using some form of asynchronous reader (like readers created by the java.nio.* classes).

The default value is true.

Parameters:

verifyReader - True if CSVReaderHeaderAware should verify reader before each read, false otherwise.

Returns:

this

withFieldAsNull

public CSVReaderHeaderAwareBuilder withFieldAsNull(CSVReaderNullFieldIndicator indicator)

Checks to see if it should treat a field with two separators, two quotes, or both as a null field.

Parameters:

indicator - CSVReaderNullFieldIndicator set to what should be considered a null field.

Returns:

this

withMultilineLimit

public CSVReaderHeaderAwareBuilder withMultilineLimit(int multilineLimit)

Sets the maximum number of lines allowed in a multiline record. More than this number in one record results in an IOException.

Parameters:

multilineLimit - No more than this number of lines is allowed in a single input record. The default is CSVReader.DEFAULT_MULTILINE_LIMIT.

Returns:

this

withErrorLocale

public CSVReaderHeaderAwareBuilder withErrorLocale(Locale errorLocale)

Sets the locale for all error messages.

Parameters:

errorLocale - Locale for error messages

Returns:

this

Since:

4.0

withLineValidator

public CSVReaderHeaderAwareBuilder withLineValidator(LineValidator lineValidator)

Adds a LineValidator to the CSVReaderHeaderAware. Multiple LineValidators can be added with multiple calls.

Parameters:

lineValidator - LineValidator to inject.

Returns:

this

Since:

5.0

withRowValidator

public CSVReaderHeaderAwareBuilder withRowValidator(RowValidator rowValidator)

Adds a RowValidator to the CSVReaderHeaderAware. Multiple RowValidators can be added with multiple calls.

Parameters:

rowValidator - RowValidator to inject

Returns:

this

Since:

5.0

withRowProcessor

public CSVReaderHeaderAwareBuilder withRowProcessor(RowProcessor rowProcessor)

Adds a RowProcessor to the CSVReaderHeaderAware. Only a single RowProcessor can be added so multiple calls will overwrite the previously set RowProcessor.

Parameters:

rowProcessor - RowProcessor to inject

Returns:

this

Since:

5.0

build

public CSVReaderHeaderAware build()
                           throws RuntimeException

Creates the CSVReaderHeaderAware.

Specified by:

build in class CSVReaderBaseBuilder<CSVReaderHeaderAware>

Returns:

The CSVReaderHeaderAware based on the set criteria.

Throws:

RuntimeException - If the header mapping cannot be initialized from the first line of data