cn.idev.excel.read.builder

Class CsvReaderBuilder

java.lang.Object

cn.idev.excel.metadata.AbstractParameterBuilder<T,C>

cn.idev.excel.read.builder.AbstractExcelReaderParameterBuilder<CsvReaderBuilder,ReadSheet>

cn.idev.excel.read.builder.CsvReaderBuilder

public class CsvReaderBuilder
extends AbstractExcelReaderParameterBuilder<CsvReaderBuilder,ReadSheet>

Builder for CSV file reading

Constructor Summary

Constructors

Constructor and Description
CsvReaderBuilder(ReadWorkbook readWorkbook)

Method Summary

Modifier and Type	Method and Description
CsvReaderBuilder	delimiter(String delimiter) Sets the delimiter character
void	doRead()
<T> List<T>	doReadSync() synchronous read and returns the results
CsvReaderBuilder	escape(Character escape) Sets the escape character.
CsvReaderBuilder	nullString(String nullString) Sets the null string
protected ReadSheet	parameter() Get parameter
CsvReaderBuilder	quote(Character quote) Sets the quote character
CsvReaderBuilder	quote(Character quote, org.apache.commons.csv.QuoteMode quoteMode) Sets the quote character and the quoting behavior
CsvReaderBuilder	recordSeparator(String recordSeparator) Sets the line separator

Methods inherited from class cn.idev.excel.read.builder.AbstractExcelReaderParameterBuilder

headRowNumber, registerReadListener, registerReadListenerIfNotNull, useScientificFormat

Methods inherited from class cn.idev.excel.metadata.AbstractParameterBuilder

autoTrim, filedCacheLocation, head, head, headIfNotNull, locale, registerConverter, self, use1904windowing

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvReaderBuilder

public CsvReaderBuilder(ReadWorkbook readWorkbook)

Method Detail

delimiter

public CsvReaderBuilder delimiter(String delimiter)

Sets the delimiter character

Parameters:

delimiter - the delimiter character

Returns:

Returns a CsvReaderBuilder object, enabling method chaining

quote

public CsvReaderBuilder quote(Character quote)

Sets the quote character

Parameters:

quote - the quote character

Returns:

Returns a CsvReaderBuilder object, enabling method chaining

quote

public CsvReaderBuilder quote(Character quote,
                              org.apache.commons.csv.QuoteMode quoteMode)

Sets the quote character and the quoting behavior

Parameters:

quote - the quote character

quoteMode - defines the quoting behavior

Returns:

Returns a CsvReaderBuilder object, enabling method chaining

recordSeparator

public CsvReaderBuilder recordSeparator(String recordSeparator)

Sets the line separator

Parameters:

recordSeparator - the line separator

Returns:

Returns a CsvReaderBuilder object, enabling method chaining

nullString

public CsvReaderBuilder nullString(String nullString)

Sets the null string

Parameters:

nullString - the String to convert to and from null

Returns:

Returns a CsvReaderBuilder object, enabling method chaining

escape

public CsvReaderBuilder escape(Character escape)

Sets the escape character.

Parameters:

escape - the Character used to escape special characters in values

Returns:

Returns a CsvReaderBuilder object, enabling method chaining

doRead

public void doRead()

doReadSync

public <T> List<T> doReadSync()

synchronous read and returns the results

Returns:

Returns a list containing the read data

parameter

protected ReadSheet parameter()

Description copied from class: AbstractParameterBuilder

Get parameter

Specified by:

parameter in class AbstractParameterBuilder<CsvReaderBuilder,ReadSheet>

Returns: