CSVReaderBaseBuilder (opencsv 5.6 API)

java.lang.Object
- com.opencsv.CSVReaderBaseBuilder<T>

Type Parameters:

T - The type pf the CSVReader class to return

Direct Known Subclasses:

CSVReaderBuilder, CSVReaderHeaderAwareBuilder
```
public abstract class CSVReaderBaseBuilder<T>
extends Object
```
Base class for the builders of various incarnations of CSVReaders.

Since:

5.5.2

Author:

Andrew Rucker Jones

Field Summary

Fields
Modifier and Type	Field and Description
`protected Locale`	`errorLocale`
`protected ICSVParser`	`icsvParser`
`protected boolean`	`keepCR`
`protected LineValidatorAggregator`	`lineValidatorAggregator`
`protected int`	`multilineLimit`
`protected CSVReaderNullFieldIndicator`	`nullFieldIndicator`
`protected Reader`	`reader`
`protected RowProcessor`	`rowProcessor`
`protected RowValidatorAggregator`	`rowValidatorAggregator`
`protected int`	`skipLines`
`protected boolean`	`verifyReader`

Constructor Summary

Constructors
Modifier Constructor and Description

protected CSVReaderBaseBuilder(Reader reader)
Base Constructor

Constructors
Modifier	Constructor and Description
`protected`	`CSVReaderBaseBuilder(Reader reader)` Base Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract T`	`build()` Must create the CSVReader type requested.
`protected ICSVParser`	`getCsvParser()` Used by unit tests.
`Locale`	`getErrorLocale()`
`LineValidatorAggregator`	`getLineValidatorAggregator()`
`protected int`	`getMultilineLimit()` Used by unit tests.
`protected ICSVParser`	`getOrCreateCsvParser()` Creates a new `ICSVParser` if the class doesn't already hold one.
`protected Reader`	`getReader()` Used by unit tests.
`RowValidatorAggregator`	`getRowValidatorAggregator()`
`protected int`	`getSkipLines()` Used by unit tests.
`boolean`	`isVerifyReader()`
`protected boolean`	`keepCarriageReturn()` Returns if the reader built will keep or discard carriage returns.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - reader
```
protected final Reader reader
```
  - lineValidatorAggregator
```
protected final LineValidatorAggregator lineValidatorAggregator
```
  - rowValidatorAggregator
```
protected final RowValidatorAggregator rowValidatorAggregator
```
  - skipLines
```
protected int skipLines
```
  - icsvParser
```
protected ICSVParser icsvParser
```
  - keepCR
```
protected boolean keepCR
```
  - verifyReader
```
protected boolean verifyReader
```
  - nullFieldIndicator
```
protected CSVReaderNullFieldIndicator nullFieldIndicator
```
  - multilineLimit
```
protected int multilineLimit
```
  - errorLocale
```
protected Locale errorLocale
```
  - rowProcessor
```
protected RowProcessor rowProcessor
```
- Constructor Detail
  - CSVReaderBaseBuilder
```
protected CSVReaderBaseBuilder(Reader reader)
```
    Base Constructor
    
    Parameters:
    
    reader - The reader to an underlying CSV source.
- Method Detail
  - getReader
```
protected Reader getReader()
```
    Used by unit tests.
    
    Returns:
    
    The reader.
  - getSkipLines
```
protected int getSkipLines()
```
    Used by unit tests.
    
    Returns:
    
    The set number of lines to skip
  - getCsvParser
```
protected ICSVParser getCsvParser()
```
    Used by unit tests.
    
    Returns:
    
    The CSVParser used by the builder.
  - getMultilineLimit
```
protected int getMultilineLimit()
```
    Used by unit tests.
    
    Returns:
    
    The upper limit on lines in multiline records.
  - keepCarriageReturn
```
protected boolean keepCarriageReturn()
```
    Returns if the reader built will keep or discard carriage returns.
    
    Returns:
    
    true if the reader built will keep carriage returns, false otherwise
  - getOrCreateCsvParser
```
protected ICSVParser getOrCreateCsvParser()
```
    Creates a new ICSVParser if the class doesn't already hold one.
    
    Returns:
    
    The injected ICSVParser or a default parser.
  - isVerifyReader
```
public boolean isVerifyReader()
```
    Returns:
    
    The flag indicating whether the reader should be verified before each read.
  - getErrorLocale
```
public Locale getErrorLocale()
```
    Returns:
    
    The locale for error messages
  - getLineValidatorAggregator
```
public LineValidatorAggregator getLineValidatorAggregator()
```
    Returns:
    
    The LineValidatorAggregator for custom defined LineValidators.
  - getRowValidatorAggregator
```
public RowValidatorAggregator getRowValidatorAggregator()
```
    Returns:
    
    The RowValidatorAggregator for the custom defined RowValidators.
  - build
```
public abstract T build()
```
    Must create the CSVReader type requested.
    
    Returns:
    
    A new instance of CSVReader or derived class

Class CSVReaderBaseBuilder<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

reader

lineValidatorAggregator

rowValidatorAggregator

skipLines

icsvParser

keepCR

verifyReader

nullFieldIndicator

multilineLimit

errorLocale

rowProcessor

Constructor Detail

CSVReaderBaseBuilder

Method Detail

getReader

getSkipLines

getCsvParser

getMultilineLimit

keepCarriageReturn

getOrCreateCsvParser

isVerifyReader

getErrorLocale

getLineValidatorAggregator

getRowValidatorAggregator

build