ExcelReaderBuilder

java.lang.Object
- com.sh.wf.excel.read.builder.ExcelReaderBuilder

public class ExcelReaderBuilder
extends java.lang.Object

Build ExcelWriter

构造器概要

构造器
构造器和说明

ExcelReaderBuilder()

构造器
构造器和说明
`ExcelReaderBuilder()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ExcelReaderBuilder`	`autoCloseStream(java.lang.Boolean autoCloseStream)` Default true
`ExcelReaderBuilder`	`autoTrim(java.lang.Boolean autoTrim)` Automatic trim includes sheet name and content
`ExcelReader`	`build()`
`ExcelReaderBuilder`	`customObject(java.lang.Object customObject)` This object can be read in the Listener `ReadListener.invoke(Object, AnalysisContext)` `AnalysisContext.getCustom()`
`ExcelReader`	`doReadAll()`
`ExcelReaderBuilder`	`excelType(ExcelTypeEnum excelType)`
`ExcelReaderBuilder`	`file(java.io.File file)` Read file If 'inputStream' and 'file' all not empty,file first
`ExcelReaderBuilder`	`file(java.io.InputStream inputStream)` Read InputStream If 'inputStream' and 'file' all not empty,file first
`ExcelReaderBuilder`	`file(java.lang.String pathName)` Read file If 'inputStream' and 'file' all not empty,file first
`ExcelReaderBuilder`	`head(java.lang.Class clazz)` You can only choose one of the `head(List)` and `head(Class)`
`ExcelReaderBuilder`	`head(java.util.List<java.util.List<java.lang.String>> head)` You can only choose one of the `head(List)` and `head(Class)`
`ExcelReaderBuilder`	`headRowNumber(java.lang.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
`ExcelReaderBuilder`	`ignoreEmptyRow(java.lang.Boolean ignoreEmptyRow)` Ignore empty rows.Default is true.
`ExcelReaderBuilder`	`mandatoryUseInputStream(java.lang.Boolean mandatoryUseInputStream)` Mandatory use 'inputStream' .Default is false.
`ExcelReaderBuilder`	`password(java.lang.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`	`registerConverter(Converter converter)` Custom type conversions override the default.
`ExcelReaderBuilder`	`registerReadListener(ReadListener readListener)` Custom type listener run after default
`ExcelReaderSheetBuilder`	`sheet()`
`ExcelReaderSheetBuilder`	`sheet(java.lang.Integer sheetNo)`
`ExcelReaderSheetBuilder`	`sheet(java.lang.Integer sheetNo, java.lang.String sheetName)`
`ExcelReaderSheetBuilder`	`sheet(java.lang.String sheetName)`
`ExcelReaderBuilder`	`use1904windowing(java.lang.Boolean use1904windowing)` true if date uses 1904 windowing, or false if using 1900 date windowing.
`ExcelReaderBuilder`	`useDefaultListener(java.lang.Boolean useDefaultListener)` Whether to use the default listener, which is used by default.
`ExcelReaderBuilder`	`xlsxSAXParserFactoryName(java.lang.String xlsxSAXParserFactoryName)` SAXParserFactory used when reading xlsx.

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - ExcelReaderBuilder
```
public ExcelReaderBuilder()
```
- 方法详细资料
  - excelType
```
public ExcelReaderBuilder excelType(ExcelTypeEnum excelType)
```
  - file
```
public ExcelReaderBuilder file(java.io.InputStream inputStream)
```
    Read InputStream If 'inputStream' and 'file' all not empty,file first
    
    参数:
    
    inputStream - InputStream
    
    返回:
    
    ExcelReaderBuilder
  - file
```
public ExcelReaderBuilder file(java.io.File file)
```
    Read file If 'inputStream' and 'file' all not empty,file first
    
    参数:
    
    file - File
    
    返回:
    
    ExcelReaderBuilder
  - file
```
public ExcelReaderBuilder file(java.lang.String pathName)
```
    Read file If 'inputStream' and 'file' all not empty,file first
    
    参数:
    
    pathName - String
    
    返回:
    
    ExcelReaderBuilder
  - mandatoryUseInputStream
```
public ExcelReaderBuilder mandatoryUseInputStream(java.lang.Boolean mandatoryUseInputStream)
```
    Mandatory use 'inputStream' .Default is false. if false,Will transfer 'inputStream' to temporary files to improve efficiency
    
    参数:
    
    mandatoryUseInputStream - Boolean
    
    返回:
    
    ExcelReaderBuilder
  - autoCloseStream
```
public ExcelReaderBuilder autoCloseStream(java.lang.Boolean autoCloseStream)
```
    Default true
    
    参数:
    
    autoCloseStream - Boolean
    
    返回:
    
    ExcelReaderBuilder
  - ignoreEmptyRow
```
public ExcelReaderBuilder ignoreEmptyRow(java.lang.Boolean ignoreEmptyRow)
```
    Ignore empty rows.Default is true.
    
    参数:
    
    ignoreEmptyRow - Boolean
    
    返回:
    
    ExcelReaderBuilder
  - customObject
```
public ExcelReaderBuilder customObject(java.lang.Object customObject)
```
    This object can be read in the Listener ReadListener.invoke(Object, AnalysisContext) AnalysisContext.getCustom()
    
    参数:
    
    customObject - Object
    
    返回:
    
    ExcelReaderBuilder
  - readCache
```
public ExcelReaderBuilder readCache(ReadCache readCache)
```
    A cache that stores temp data to save memory.
    
    参数:
    
    readCache - ReadCache
    
    返回:
    
    ExcelReaderBuilder
  - readCacheSelector
```
public ExcelReaderBuilder readCacheSelector(ReadCacheSelector readCacheSelector)
```
    Select the cache.Default use SimpleReadCacheSelector
    
    参数:
    
    readCacheSelector - ReadCacheSelector
    
    返回:
    
    ExcelReaderBuilder
  - headRowNumber
```
public ExcelReaderBuilder headRowNumber(java.lang.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 - Integer
    
    返回:
    
    ExcelReaderBuilder
  - head
```
public ExcelReaderBuilder head(java.util.List<java.util.List<java.lang.String>> head)
```
    You can only choose one of the head(List) and head(Class)
    
    参数:
    
    head - List
    
    返回:
    
    ExcelReaderBuilder
  - head
```
public ExcelReaderBuilder head(java.lang.Class clazz)
```
    You can only choose one of the head(List) and head(Class)
    
    参数:
    
    clazz - Class
    
    返回:
    
    ExcelReaderBuilder
  - registerConverter
```
public ExcelReaderBuilder registerConverter(Converter converter)
```
    Custom type conversions override the default.
    
    参数:
    
    converter - Converter
    
    返回:
    
    ExcelReaderBuilder
  - registerReadListener
```
public ExcelReaderBuilder registerReadListener(ReadListener readListener)
```
    Custom type listener run after default
    
    参数:
    
    readListener - ReadListener
    
    返回:
    
    ExcelReaderBuilder
  - use1904windowing
```
public ExcelReaderBuilder use1904windowing(java.lang.Boolean use1904windowing)
```
    true if date uses 1904 windowing, or false if using 1900 date windowing. default is false
    
    参数:
    
    use1904windowing - Boolean
    
    返回:
    
    ExcelReaderBuilder
  - autoTrim
```
public ExcelReaderBuilder autoTrim(java.lang.Boolean autoTrim)
```
    Automatic trim includes sheet name and content
    
    参数:
    
    autoTrim - Boolean
    
    返回:
    
    ExcelReaderBuilder
  - password
```
public ExcelReaderBuilder password(java.lang.String password)
```
    Whether the encryption
    
    参数:
    
    password - String
    
    返回:
    
    ExcelReaderBuilder
  - xlsxSAXParserFactoryName
```
public ExcelReaderBuilder xlsxSAXParserFactoryName(java.lang.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 - String
    
    返回:
    
    ExcelReaderBuilder
    
    另请参阅:
    
    SAXParserFactory.newInstance(), SAXParserFactory.newInstance(String, ClassLoader)
  - useDefaultListener
```
public ExcelReaderBuilder useDefaultListener(java.lang.Boolean useDefaultListener)
```
    Whether to use the default listener, which is used by default.
    The ModelBuildEventListener is loaded by default to convert the object.
    
    参数:
    
    useDefaultListener - Boolean
    
    返回:
    
    ExcelReaderBuilder
  - build
```
public ExcelReader build()
```
  - doReadAll
```
public ExcelReader doReadAll()
```
  - sheet
```
public ExcelReaderSheetBuilder sheet()
```
  - sheet
```
public ExcelReaderSheetBuilder sheet(java.lang.Integer sheetNo)
```
  - sheet
```
public ExcelReaderSheetBuilder sheet(java.lang.String sheetName)
```
  - sheet
```
public ExcelReaderSheetBuilder sheet(java.lang.Integer sheetNo,
                                     java.lang.String sheetName)
```

类 ExcelReaderBuilder

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

ExcelReaderBuilder

方法详细资料

excelType

file

file

file

mandatoryUseInputStream

autoCloseStream

ignoreEmptyRow

customObject

readCache

readCacheSelector

headRowNumber

head

head

registerConverter

registerReadListener

use1904windowing

autoTrim

password

xlsxSAXParserFactoryName

useDefaultListener

build

doReadAll

sheet

sheet

sheet

sheet