ExcelWriterBuilder

java.lang.Object
- com.sh.wf.excel.write.builder.ExcelWriterBuilder

public class ExcelWriterBuilder
extends java.lang.Object

Build ExcelBuilder

构造器概要

构造器
构造器和说明

ExcelWriterBuilder()

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

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`ExcelWriterBuilder`	`autoCloseStream(java.lang.Boolean autoCloseStream)` Default true
`ExcelWriterBuilder`	`automaticMergeHead(java.lang.Boolean automaticMergeHead)` Whether to automatically merge headers.Default is true.
`ExcelWriter`	`build()`
`ExcelWriterBuilder`	`convertAllFiled(java.lang.Boolean convertAllFiled)` 已过时。 Just to be compatible with historical data, The default is always going to be convert all filed.
`ExcelWriterBuilder`	`excelType(ExcelTypeEnum excelType)`
`ExcelWriterBuilder`	`excludeColumnFiledNames(java.util.Collection<java.lang.String> excludeColumnFiledNames)` Ignore the custom columns.
`ExcelWriterBuilder`	`excludeColumnIndexes(java.util.Collection<java.lang.Integer> excludeColumnIndexes)` Ignore the custom columns.
`ExcelWriterBuilder`	`file(java.io.File outputFile)`
`ExcelWriterBuilder`	`file(java.io.OutputStream outputStream)`
`ExcelWriterBuilder`	`file(java.lang.String outputPathName)`
`ExcelWriterBuilder`	`head(java.lang.Class clazz)` You can only choose one of the `head(List)` and `head(Class)`
`ExcelWriterBuilder`	`head(java.util.List<java.util.List<java.lang.String>> head)` You can only choose one of the `head(List)` and `head(Class)`
`ExcelWriterBuilder`	`includeColumnFiledNames(java.util.Collection<java.lang.String> includeColumnFiledNames)` Only output the custom columns.
`ExcelWriterBuilder`	`includeColumnIndexes(java.util.Collection<java.lang.Integer> includeColumnIndexes)` Only output the custom columns.
`ExcelWriterBuilder`	`inMemory(java.lang.Boolean inMemory)` Write excel in memory.
`ExcelWriterBuilder`	`needHead(java.lang.Boolean needHead)`
`ExcelWriterBuilder`	`password(java.lang.String password)` Whether the encryption.
`ExcelWriterBuilder`	`registerConverter(Converter converter)` Custom type conversions override the default.
`ExcelWriterBuilder`	`registerWriteHandler(WriteHandler writeHandler)` Custom write handler
`ExcelWriterBuilder`	`registerWriteHandler(WriteHandler writeHandler)` 已过时。 please use `WriteHandler`
`ExcelWriterBuilder`	`relativeHeadRowIndex(java.lang.Integer relativeHeadRowIndex)` Writes the head relative to the existing contents of the sheet.
`ExcelWriterSheetBuilder`	`sheet()`
`ExcelWriterSheetBuilder`	`sheet(java.lang.Integer sheetNo)`
`ExcelWriterSheetBuilder`	`sheet(java.lang.Integer sheetNo, java.lang.String sheetName)`
`ExcelWriterSheetBuilder`	`sheet(java.lang.String sheetName)`
`ExcelWriterBuilder`	`useDefaultStyle(java.lang.Boolean useDefaultStyle)` Use the default style.Default is true.
`ExcelWriterBuilder`	`withTemplate(java.io.File templateFile)`
`ExcelWriterBuilder`	`withTemplate(java.io.InputStream templateInputStream)`
`ExcelWriterBuilder`	`withTemplate(java.lang.String pathName)`
`ExcelWriterBuilder`	`writeExcelOnException(java.lang.Boolean writeExcelOnException)` Excel is also written in the event of an exception being thrown.The default false.

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

- 构造器详细资料
  - ExcelWriterBuilder
```
public ExcelWriterBuilder()
```
- 方法详细资料
  - relativeHeadRowIndex
```
public ExcelWriterBuilder relativeHeadRowIndex(java.lang.Integer relativeHeadRowIndex)
```
    Writes the head relative to the existing contents of the sheet. Indexes are zero-based.
    
    参数:
    
    relativeHeadRowIndex - Integer
    
    返回:
    
    ExcelWriterBuilder
  - head
```
public ExcelWriterBuilder 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
    
    返回:
    
    ExcelWriterBuilder
  - head
```
public ExcelWriterBuilder head(java.lang.Class clazz)
```
    You can only choose one of the head(List) and head(Class)
    
    参数:
    
    clazz - Class
    
    返回:
    
    ExcelWriterBuilder
  - needHead
```
public ExcelWriterBuilder needHead(java.lang.Boolean needHead)
```
  - autoCloseStream
```
public ExcelWriterBuilder autoCloseStream(java.lang.Boolean autoCloseStream)
```
    Default true
    
    参数:
    
    autoCloseStream - Boolean
    
    返回:
    
    ExcelWriterBuilder
  - useDefaultStyle
```
public ExcelWriterBuilder useDefaultStyle(java.lang.Boolean useDefaultStyle)
```
    Use the default style.Default is true.
    
    参数:
    
    useDefaultStyle - Boolean
    
    返回:
    
    ExcelWriterBuilder
  - automaticMergeHead
```
public ExcelWriterBuilder automaticMergeHead(java.lang.Boolean automaticMergeHead)
```
    Whether to automatically merge headers.Default is true.
    
    参数:
    
    automaticMergeHead - Boolean
    
    返回:
    
    ExcelWriterBuilder
  - password
```
public ExcelWriterBuilder password(java.lang.String password)
```
    Whether the encryption. WARRING:Encryption is when the entire file is read into memory, so it is very memory intensive.
    
    参数:
    
    password - String
    
    返回:
    
    ExcelWriterBuilder
  - inMemory
```
public ExcelWriterBuilder inMemory(java.lang.Boolean inMemory)
```
    Write excel in memory. Default false,the cache file is created and finally written to excel. Comment and RichTextString are only supported in memory mode.
    
    参数:
    
    inMemory - Boolean
    
    返回:
    
    ExcelWriterBuilder
  - excludeColumnIndexes
```
public ExcelWriterBuilder excludeColumnIndexes(java.util.Collection<java.lang.Integer> excludeColumnIndexes)
```
    Ignore the custom columns.
    
    参数:
    
    excludeColumnIndexes - Collection
    
    返回:
    
    ExcelWriterBuilder
  - excludeColumnFiledNames
```
public ExcelWriterBuilder excludeColumnFiledNames(java.util.Collection<java.lang.String> excludeColumnFiledNames)
```
    Ignore the custom columns.
    
    参数:
    
    excludeColumnFiledNames - Collection
    
    返回:
    
    ExcelWriterBuilder
  - includeColumnIndexes
```
public ExcelWriterBuilder includeColumnIndexes(java.util.Collection<java.lang.Integer> includeColumnIndexes)
```
    Only output the custom columns.
    
    参数:
    
    includeColumnIndexes - Collection
    
    返回:
    
    ExcelWriterBuilder
  - includeColumnFiledNames
```
public ExcelWriterBuilder includeColumnFiledNames(java.util.Collection<java.lang.String> includeColumnFiledNames)
```
    Only output the custom columns.
    
    参数:
    
    includeColumnFiledNames - Collection
    
    返回:
    
    ExcelWriterBuilder
  - writeExcelOnException
```
public ExcelWriterBuilder writeExcelOnException(java.lang.Boolean writeExcelOnException)
```
    Excel is also written in the event of an exception being thrown.The default false.
    
    参数:
    
    writeExcelOnException - Collection
    
    返回:
    
    ExcelWriterBuilder
  - convertAllFiled
```
@Deprecated
public ExcelWriterBuilder convertAllFiled(java.lang.Boolean convertAllFiled)
```
    已过时。 Just to be compatible with historical data, The default is always going to be convert all filed.
    
    The default is all excel objects.if true , you can use ExcelIgnore ignore a field. if false , you must use ExcelProperty to use a filed.
    Default true
    
    参数:
    
    convertAllFiled - Boolean
    
    返回:
    
    ExcelWriterBuilder
  - registerConverter
```
public ExcelWriterBuilder registerConverter(Converter converter)
```
    Custom type conversions override the default.
    
    参数:
    
    converter - Converter
    
    返回:
    
    ExcelWriterBuilder
  - registerWriteHandler
```
public ExcelWriterBuilder registerWriteHandler(WriteHandler writeHandler)
```
    Custom write handler
    
    参数:
    
    writeHandler - WriteHandler
    
    返回:
    
    ExcelWriterBuilder
  - excelType
```
public ExcelWriterBuilder excelType(ExcelTypeEnum excelType)
```
  - file
```
public ExcelWriterBuilder file(java.io.OutputStream outputStream)
```
  - file
```
public ExcelWriterBuilder file(java.io.File outputFile)
```
  - file
```
public ExcelWriterBuilder file(java.lang.String outputPathName)
```
  - withTemplate
```
public ExcelWriterBuilder withTemplate(java.io.InputStream templateInputStream)
```
  - withTemplate
```
public ExcelWriterBuilder withTemplate(java.io.File templateFile)
```
  - withTemplate
```
public ExcelWriterBuilder withTemplate(java.lang.String pathName)
```
  - registerWriteHandler
```
@Deprecated
public ExcelWriterBuilder registerWriteHandler(WriteHandler writeHandler)
```
    已过时。 please use WriteHandler
    
    Write handler
    
    参数:
    
    writeHandler - WriteHandler
    
    返回:
    
    ExcelWriterBuilder
  - build
```
public ExcelWriter build()
```
  - sheet
```
public ExcelWriterSheetBuilder sheet()
```
  - sheet
```
public ExcelWriterSheetBuilder sheet(java.lang.Integer sheetNo)
```
  - sheet
```
public ExcelWriterSheetBuilder sheet(java.lang.String sheetName)
```
  - sheet
```
public ExcelWriterSheetBuilder sheet(java.lang.Integer sheetNo,
                                     java.lang.String sheetName)
```

类 ExcelWriterBuilder

构造器概要

方法概要

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

构造器详细资料

ExcelWriterBuilder

方法详细资料

relativeHeadRowIndex

head

head

needHead

autoCloseStream

useDefaultStyle

automaticMergeHead

password

inMemory

excludeColumnIndexes

excludeColumnFiledNames

includeColumnIndexes

includeColumnFiledNames

writeExcelOnException

convertAllFiled

registerConverter

registerWriteHandler

excelType

file

file

file

withTemplate

withTemplate

withTemplate

registerWriteHandler

build

sheet

sheet

sheet

sheet