com.alibaba.excel.read.builder
类 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- 作者:
- Jiaju Zhuang
-
构造器概要
构造器 构造器和说明 ExcelReaderBuilder()
方法概要
所有方法 实例方法 具体方法 限定符和类型 方法和说明 ExcelReaderBuilder
autoCloseStream(Boolean autoCloseStream)
Default trueExcelReader
build()
ExcelReaderBuilder
customObject(Object customObject)
This object can be read in the ListenerReadListener.invoke(Object, AnalysisContext)
AnalysisContext.getCustom()
void
doReadAll()
<T> List<T>
doReadAllSync()
Synchronous reads return resultsExcelReaderBuilder
excelType(ExcelTypeEnum excelType)
ExcelReaderBuilder
extraRead(CellExtraTypeEnum extraType)
Read some extra information, not by defaultExcelReaderBuilder
file(File file)
Read file If 'inputStream' and 'file' all not empty, file firstExcelReaderBuilder
file(InputStream inputStream)
Read InputStream If 'inputStream' and 'file' all not empty, file firstExcelReaderBuilder
file(String pathName)
Read file If 'inputStream' and 'file' all not empty, file firstExcelReaderBuilder
ignoreEmptyRow(Boolean ignoreEmptyRow)
Ignore empty rows.Default is true.ExcelReaderBuilder
mandatoryUseInputStream(Boolean mandatoryUseInputStream)
Mandatory use 'inputStream' .Default is false.protected ReadWorkbook
parameter()
Get parameterExcelReaderBuilder
password(String password)
Whether the encryptionExcelReaderBuilder
readCache(ReadCache readCache)
A cache that stores temp data to save memory.ExcelReaderBuilder
readCacheSelector(ReadCacheSelector readCacheSelector)
Select the cache.Default useSimpleReadCacheSelector
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.从类继承的方法 com.alibaba.excel.read.builder.AbstractExcelReaderParameterBuilder
headRowNumber, registerReadListener, useScientificFormat
从类继承的方法 com.alibaba.excel.metadata.AbstractParameterBuilder
autoTrim, head, head, locale, registerConverter, self, use1904windowing
-
方法详细资料
excelType
public ExcelReaderBuilder excelType(ExcelTypeEnum excelType)
file
public ExcelReaderBuilder file(InputStream inputStream)
Read InputStreamIf 'inputStream' and 'file' all not empty, file first
file
public ExcelReaderBuilder file(File file)
Read fileIf 'inputStream' and 'file' all not empty, file first
file
public ExcelReaderBuilder file(String pathName)
Read fileIf 'inputStream' and 'file' all not empty, file first
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- 参数:
-
autoCloseStream
- - 返回:
ignoreEmptyRow
public ExcelReaderBuilder ignoreEmptyRow(Boolean ignoreEmptyRow)
Ignore empty rows.Default is true.- 参数:
-
ignoreEmptyRow
- - 返回:
customObject
public ExcelReaderBuilder customObject(Object customObject)
This object can be read in the ListenerReadListener.invoke(Object, AnalysisContext)
AnalysisContext.getCustom()
- 参数:
-
customObject
- - 返回:
readCache
public ExcelReaderBuilder readCache(ReadCache readCache)
A cache that stores temp data to save memory.- 参数:
-
readCache
- - 返回:
readCacheSelector
public ExcelReaderBuilder readCacheSelector(ReadCacheSelector readCacheSelector)
Select the cache.Default useSimpleReadCacheSelector
- 参数:
-
readCacheSelector
- - 返回:
password
public ExcelReaderBuilder password(String password)
Whether the encryption- 参数:
-
password
- - 返回:
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"
- 参数:
-
xlsxSAXParserFactoryName
- - 返回:
- 另请参阅:
-
SAXParserFactory.newInstance()
,SAXParserFactory.newInstance(String, ClassLoader)
extraRead
public ExcelReaderBuilder extraRead(CellExtraTypeEnum extraType)
Read some extra information, not by default- 参数:
-
extraType
- extra information type - 返回:
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.- 参数:
-
useDefaultListener
- - 返回:
build
public ExcelReader build()
doReadAll
public void doReadAll()
doReadAllSync
public <T> List<T> doReadAllSync()
Synchronous reads return results- 返回:
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()
从类复制的说明:AbstractParameterBuilder
Get parameter- 指定者:
-
parameter
在类中AbstractParameterBuilder<ExcelReaderBuilder,ReadWorkbook>
- 返回:
Copyright © 2018–2021 Alibaba Group. All rights reserved.