com.alibaba.excel.read.builder

Class ExcelReaderBuilder

java.lang.Object

com.alibaba.excel.metadata.AbstractParameterBuilder<T,C>

com.alibaba.excel.read.builder.AbstractExcelReaderParameterBuilder<ExcelReaderBuilder,ReadWorkbook>

com.alibaba.excel.read.builder.ExcelReaderBuilder

public class ExcelReaderBuilder
extends AbstractExcelReaderParameterBuilder<ExcelReaderBuilder,ReadWorkbook>

Build ExcelWriter

Author:

Jiaju Zhuang

Constructor Summary

Constructors

Constructor and Description
ExcelReaderBuilder()

Method Summary

Modifier and Type	Method and Description
ExcelReaderBuilder	autoCloseStream(Boolean autoCloseStream) Default true
ExcelReader	build()
ExcelReaderBuilder	charset(Charset charset) charset.
ExcelReaderBuilder	customObject(Object customObject) This object can be read in the Listener ReadListener.invoke(Object, AnalysisContext) AnalysisContext.getCustom()
void	doReadAll()
<T> List<T>	doReadAllSync() Synchronous reads return results
ExcelReaderBuilder	excelType(ExcelTypeEnum excelType)
ExcelReaderBuilder	extraRead(CellExtraTypeEnum extraType) Read some extra information, not by default
ExcelReaderBuilder	file(File file) Read file
ExcelReaderBuilder	file(InputStream inputStream) Read InputStream
ExcelReaderBuilder	file(String pathName) Read file
ExcelReaderBuilder	ignoreEmptyRow(Boolean ignoreEmptyRow) Ignore empty rows.Default is true.
ExcelReaderBuilder	mandatoryUseInputStream(Boolean mandatoryUseInputStream) Mandatory use 'inputStream' .Default is false.
protected ReadWorkbook	parameter() Get parameter
ExcelReaderBuilder	password(String password) Whether the encryption
ExcelReaderBuilder	readCache(ReadCache readCache) A cache that stores temp data to save memory.
ExcelReaderBuilder	readCacheSelector(ReadCacheSelector readCacheSelector) Select the cache.Default use SimpleReadCacheSelector
ExcelReaderBuilder	readDefaultReturn(ReadDefaultReturnEnum readDefaultReturn) Read not to com.alibaba.excel.metadata.BasicParameter#clazz value, the default will return type.
ExcelReaderSheetBuilder	sheet()
ExcelReaderSheetBuilder	sheet(Integer sheetNo)
ExcelReaderSheetBuilder	sheet(Integer sheetNo, String sheetName)
ExcelReaderSheetBuilder	sheet(String sheetName)
ExcelReaderBuilder	useDefaultListener(Boolean useDefaultListener) Whether to use the default listener, which is used by default.
ExcelReaderBuilder	xlsxSAXParserFactoryName(String xlsxSAXParserFactoryName) SAXParserFactory used when reading xlsx.

Methods inherited from class com.alibaba.excel.read.builder.AbstractExcelReaderParameterBuilder

headRowNumber, registerReadListener, useScientificFormat

Methods inherited from class com.alibaba.excel.metadata.AbstractParameterBuilder

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelReaderBuilder

public ExcelReaderBuilder()

Method Detail

excelType

public ExcelReaderBuilder excelType(ExcelTypeEnum excelType)

file

public ExcelReaderBuilder file(InputStream inputStream)

Read InputStream

If 'inputStream' and 'file' all not empty, file first

file

public ExcelReaderBuilder file(File file)

Read file

If 'inputStream' and 'file' all not empty, file first

file

public ExcelReaderBuilder file(String pathName)

Read file

If 'inputStream' and 'file' all not empty, file first

charset

public ExcelReaderBuilder charset(Charset charset)

charset. Only work on the CSV file

mandatoryUseInputStream

public ExcelReaderBuilder mandatoryUseInputStream(Boolean mandatoryUseInputStream)

Mandatory use 'inputStream' .Default is false.

if false, Will transfer 'inputStream' to temporary files to improve efficiency

autoCloseStream

public ExcelReaderBuilder autoCloseStream(Boolean autoCloseStream)

Default true

Parameters:

autoCloseStream -

Returns:

ignoreEmptyRow

public ExcelReaderBuilder ignoreEmptyRow(Boolean ignoreEmptyRow)

Ignore empty rows.Default is true.

Parameters:

ignoreEmptyRow -

Returns:

customObject

public ExcelReaderBuilder customObject(Object customObject)

This object can be read in the Listener ReadListener.invoke(Object, AnalysisContext) AnalysisContext.getCustom()

Parameters:

customObject -

Returns:

readCache

public ExcelReaderBuilder readCache(ReadCache readCache)

A cache that stores temp data to save memory.

Parameters:

readCache -

Returns:

readCacheSelector

public ExcelReaderBuilder readCacheSelector(ReadCacheSelector readCacheSelector)

Select the cache.Default use SimpleReadCacheSelector

Parameters:

readCacheSelector -

Returns:

password

public ExcelReaderBuilder password(String password)

Whether the encryption

Parameters:

password -

Returns:

xlsxSAXParserFactoryName

public ExcelReaderBuilder xlsxSAXParserFactoryName(String xlsxSAXParserFactoryName)

SAXParserFactory used when reading xlsx.

The default will automatically find.

Please pass in the name of a class ,like : "com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl"

Parameters:

xlsxSAXParserFactoryName -

Returns:

See Also:

SAXParserFactory.newInstance(), SAXParserFactory.newInstance(String, ClassLoader)

extraRead

public ExcelReaderBuilder extraRead(CellExtraTypeEnum extraType)

Read some extra information, not by default

Parameters:

extraType - extra information type

Returns:

useDefaultListener

public ExcelReaderBuilder useDefaultListener(Boolean useDefaultListener)

Whether to use the default listener, which is used by default.

The ModelBuildEventListener is loaded by default to convert the object.

Parameters:

useDefaultListener -

Returns:

readDefaultReturn

public ExcelReaderBuilder readDefaultReturn(ReadDefaultReturnEnum readDefaultReturn)

Read not to com.alibaba.excel.metadata.BasicParameter#clazz value, the default will return type. Is only effective when set `useDefaultListener=true` or `useDefaultListener=null`.

See Also:

ReadDefaultReturnEnum

build

public ExcelReader build()

doReadAll

public void doReadAll()

doReadAllSync

public <T> List<T> doReadAllSync()

Synchronous reads return results

Returns:

sheet

public ExcelReaderSheetBuilder sheet()

sheet

public ExcelReaderSheetBuilder sheet(Integer sheetNo)

sheet

public ExcelReaderSheetBuilder sheet(String sheetName)

sheet

public ExcelReaderSheetBuilder sheet(Integer sheetNo,
                                     String sheetName)

parameter

protected ReadWorkbook parameter()

Description copied from class: AbstractParameterBuilder

Get parameter

Specified by:

parameter in class AbstractParameterBuilder<ExcelReaderBuilder,ReadWorkbook>

Returns: