com.alibaba.excel.read.builder
类 ExcelReaderBuilder
- java.lang.Object
-
- com.alibaba.excel.read.builder.ExcelReaderBuilder
public class ExcelReaderBuilder extends Object
Build ExcelWriter- 作者:
- Jiaju Zhuang
-
构造器概要
构造器 构造器和说明 ExcelReaderBuilder()
方法概要
所有方法 实例方法 具体方法 限定符和类型 方法和说明 ExcelReaderBuilder
autoCloseStream(Boolean autoCloseStream)
Default trueExcelReaderBuilder
autoTrim(Boolean autoTrim)
Automatic trim includes sheet name and contentExcelReader
build()
ExcelReaderBuilder
customObject(Object customObject)
This object can be read in the ListenerReadListener.invoke(Object, AnalysisContext)
AnalysisContext.getCustom()
ExcelReader
doReadAll()
ExcelReaderBuilder
excelType(ExcelTypeEnum excelType)
ExcelReaderBuilder
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
head(Class clazz)
You can only choose one of thehead(List)
andhead(Class)
ExcelReaderBuilder
head(List<List<String>> head)
You can only choose one of thehead(List)
andhead(Class)
ExcelReaderBuilder
headRowNumber(Integer headRowNumber)
Count the number of added heads when read sheet.ExcelReaderBuilder
ignoreEmptyRow(Boolean ignoreEmptyRow)
Ignore empty rows.Default is true.ExcelReaderBuilder
mandatoryUseInputStream(Boolean mandatoryUseInputStream)
Mandatory use 'inputStream' .Default is false.ExcelReaderBuilder
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
ExcelReaderBuilder
registerConverter(Converter converter)
Custom type conversions override the default.ExcelReaderBuilder
registerReadListener(ReadListener readListener)
Custom type listener run after defaultExcelReaderSheetBuilder
sheet()
ExcelReaderSheetBuilder
sheet(Integer sheetNo)
ExcelReaderSheetBuilder
sheet(Integer sheetNo, String sheetName)
ExcelReaderSheetBuilder
sheet(String sheetName)
ExcelReaderBuilder
use1904windowing(Boolean use1904windowing)
true if date uses 1904 windowing, or false if using 1900 date windowing.ExcelReaderBuilder
useDefaultListener(Boolean useDefaultListener)
Whether to use the default listener, which is used by default.ExcelReaderBuilder
xlsxSAXParserFactoryName(String xlsxSAXParserFactoryName)
SAXParserFactory used when reading xlsx.
-
方法详细资料
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
- - 返回:
headRowNumber
public ExcelReaderBuilder headRowNumber(Integer headRowNumber)
Count the number of added heads when read sheet.0 - This Sheet has no head ,since the first row are the data
1 - This Sheet has one row head , this is the default
2 - This Sheet has two row head ,since the third row is the data
- 参数:
-
headRowNumber
- - 返回:
head
public ExcelReaderBuilder head(List<List<String>> head)
You can only choose one of thehead(List)
andhead(Class)
- 参数:
-
head
- - 返回:
head
public ExcelReaderBuilder head(Class clazz)
You can only choose one of thehead(List)
andhead(Class)
- 参数:
-
clazz
- - 返回:
registerConverter
public ExcelReaderBuilder registerConverter(Converter converter)
Custom type conversions override the default.- 参数:
-
converter
- - 返回:
registerReadListener
public ExcelReaderBuilder registerReadListener(ReadListener readListener)
Custom type listener run after default- 参数:
-
readListener
- - 返回:
use1904windowing
public ExcelReaderBuilder use1904windowing(Boolean use1904windowing)
true if date uses 1904 windowing, or false if using 1900 date windowing. default is false- 参数:
-
use1904windowing
- - 返回:
autoTrim
public ExcelReaderBuilder autoTrim(Boolean autoTrim)
Automatic trim includes sheet name and content- 参数:
-
autoTrim
- - 返回:
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)
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 ExcelReader doReadAll()
sheet
public ExcelReaderSheetBuilder sheet()
sheet
public ExcelReaderSheetBuilder sheet(Integer sheetNo)
sheet
public ExcelReaderSheetBuilder sheet(String sheetName)
sheet
public ExcelReaderSheetBuilder sheet(Integer sheetNo, String sheetName)
Copyright © 2018–2019 Alibaba Group. All rights reserved.