Package com.opencsv
Class CSVReaderBuilder
- java.lang.Object
-
- com.opencsv.CSVReaderBaseBuilder<CSVReader>
-
- com.opencsv.CSVReaderBuilder
-
public class CSVReaderBuilder extends CSVReaderBaseBuilder<CSVReader>
Builder for creating aCSVReader
.This should be the preferred method of creating a Reader as there are so many possible values to be set it is impossible to have constructors for all of them and keep backwards compatibility with previous constructors.
final CSVParser parser =
new CSVParserBuilder()
.withSeparator('\t')
.withIgnoreQuotations(true)
.build();
final CSVReader reader =
new CSVReaderBuilder(new StringReader(csv))
.withSkipLines(1)
.withCSVParser(parser)
.build();
- See Also:
CSVReader
-
-
Field Summary
-
Fields inherited from class com.opencsv.CSVReaderBaseBuilder
errorLocale, icsvParser, keepCR, lineValidatorAggregator, multilineLimit, nullFieldIndicator, reader, rowProcessor, rowValidatorAggregator, skipLines, verifyReader
-
-
Constructor Summary
Constructors Constructor Description CSVReaderBuilder(java.io.Reader reader)
Sets the reader to an underlying CSV source.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CSVReader
build()
Creates theCSVReader
.CSVReaderBuilder
withCSVParser(ICSVParser icsvParser)
Sets the parser to use to parse the input.CSVReaderBuilder
withErrorLocale(java.util.Locale errorLocale)
Sets the locale for all error messages.CSVReaderBuilder
withFieldAsNull(CSVReaderNullFieldIndicator indicator)
Checks to see if it should treat a field with two separators, two quotes, or both as a null field.CSVReaderBuilder
withKeepCarriageReturn(boolean keepCR)
Sets if the reader will keep or discard carriage returns.CSVReaderBuilder
withLineValidator(LineValidator lineValidator)
Adds aLineValidator
to theCSVReader
.CSVReaderBuilder
withMultilineLimit(int multilineLimit)
Sets the maximum number of lines allowed in a multiline record.CSVReaderBuilder
withRowProcessor(RowProcessor rowProcessor)
Adds aRowProcessor
to theCSVReader
.CSVReaderBuilder
withRowValidator(RowValidator rowValidator)
Adds aRowValidator
to theCSVReader
.CSVReaderBuilder
withSkipLines(int skipLines)
Sets the number of lines to skip before reading.CSVReaderBuilder
withVerifyReader(boolean verifyReader)
Checks to see if theCSVReader
should verify the reader state before reads or not.-
Methods inherited from class com.opencsv.CSVReaderBaseBuilder
getCsvParser, getErrorLocale, getLineValidatorAggregator, getMultilineLimit, getOrCreateCsvParser, getReader, getRowValidatorAggregator, getSkipLines, isVerifyReader, keepCarriageReturn
-
-
-
-
Method Detail
-
withSkipLines
public CSVReaderBuilder 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 CSVReaderBuilder withCSVParser(ICSVParser icsvParser)
Sets the parser to use to parse the input.- Parameters:
icsvParser
- The parser to use to parse the input.- Returns:
this
-
build
public CSVReader build()
Creates theCSVReader
.- Specified by:
build
in classCSVReaderBaseBuilder<CSVReader>
- Returns:
- The
CSVReader
based on the set criteria.
-
withKeepCarriageReturn
public CSVReaderBuilder 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 CSVReaderBuilder withVerifyReader(boolean verifyReader)
Checks to see if theCSVReader
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 ifCSVReader
should verify reader before each read, false otherwise.- Returns:
this
-
withFieldAsNull
public CSVReaderBuilder 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 CSVReaderBuilder 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 isCSVReader.DEFAULT_MULTILINE_LIMIT
.- Returns:
this
-
withErrorLocale
public CSVReaderBuilder withErrorLocale(java.util.Locale errorLocale)
Sets the locale for all error messages.- Parameters:
errorLocale
- Locale for error messages- Returns:
this
- Since:
- 4.0
-
withLineValidator
public CSVReaderBuilder withLineValidator(LineValidator lineValidator)
- Parameters:
lineValidator
-LineValidator
to inject.- Returns:
this
- Since:
- 5.0
-
withRowValidator
public CSVReaderBuilder withRowValidator(RowValidator rowValidator)
- Parameters:
rowValidator
-RowValidator
to inject- Returns:
this
- Since:
- 5.0
-
withRowProcessor
public CSVReaderBuilder withRowProcessor(RowProcessor rowProcessor)
Adds aRowProcessor
to theCSVReader
. Only a singleRowProcessor
can be added so multiple calls will overwrite the previously setRowProcessor
.- Parameters:
rowProcessor
-RowProcessor
to inject- Returns:
this
- Since:
- 5.0
-
-