com.alibaba.excel.write.builder

类 ExcelWriterBuilder

java.lang.Object

com.alibaba.excel.write.builder.ExcelWriterBuilder

public class ExcelWriterBuilder
extends Object

Build ExcelBuilder

作者:

Jiaju Zhuang

构造器概要

构造器

构造器和说明
ExcelWriterBuilder()

方法概要

限定符和类型	方法和说明
ExcelWriterBuilder	autoCloseStream(Boolean autoCloseStream) Default true
ExcelWriterBuilder	automaticMergeHead(Boolean automaticMergeHead) Whether to automatically merge headers.Default is true.
ExcelWriter	build()
ExcelWriterBuilder	convertAllFiled(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(Collection<String> excludeColumnFiledNames) Ignore the custom columns.
ExcelWriterBuilder	excludeColumnIndexes(Collection<Integer> excludeColumnIndexes) Ignore the custom columns.
ExcelWriterBuilder	file(File outputFile)
ExcelWriterBuilder	file(OutputStream outputStream)
ExcelWriterBuilder	file(String outputPathName)
ExcelWriterBuilder	head(Class clazz) You can only choose one of the head(List) and head(Class)
ExcelWriterBuilder	head(List<List<String>> head) You can only choose one of the head(List) and head(Class)
ExcelWriterBuilder	includeColumnFiledNames(Collection<String> includeColumnFiledNames) Only output the custom columns.
ExcelWriterBuilder	includeColumnIndexes(Collection<Integer> includeColumnIndexes) Only output the custom columns.
ExcelWriterBuilder	inMemory(Boolean inMemory) Write excel in memory.
ExcelWriterBuilder	needHead(Boolean needHead) Need Head
ExcelWriterBuilder	password(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(Integer relativeHeadRowIndex) Writes the head relative to the existing contents of the sheet.
ExcelWriterSheetBuilder	sheet()
ExcelWriterSheetBuilder	sheet(Integer sheetNo)
ExcelWriterSheetBuilder	sheet(Integer sheetNo, String sheetName)
ExcelWriterSheetBuilder	sheet(String sheetName)
ExcelWriterBuilder	useDefaultStyle(Boolean useDefaultStyle) Use the default style.Default is true.
ExcelWriterBuilder	withTemplate(File templateFile)
ExcelWriterBuilder	withTemplate(InputStream templateInputStream)
ExcelWriterBuilder	withTemplate(String pathName)
ExcelWriterBuilder	writeExcelOnException(Boolean writeExcelOnException) Excel is also written in the event of an exception being thrown.The default false.

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

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

构造器详细资料

ExcelWriterBuilder

public ExcelWriterBuilder()

方法详细资料

relativeHeadRowIndex

public ExcelWriterBuilder relativeHeadRowIndex(Integer relativeHeadRowIndex)

Writes the head relative to the existing contents of the sheet. Indexes are zero-based.

参数:

relativeHeadRowIndex -

返回:

head

public ExcelWriterBuilder head(List<List<String>> head)

You can only choose one of the head(List) and head(Class)

参数:

head -

返回:

head

public ExcelWriterBuilder head(Class clazz)

You can only choose one of the head(List) and head(Class)

参数:

clazz -

返回:

needHead

public ExcelWriterBuilder needHead(Boolean needHead)

Need Head

autoCloseStream

public ExcelWriterBuilder autoCloseStream(Boolean autoCloseStream)

Default true

参数:

autoCloseStream -

返回:

useDefaultStyle

public ExcelWriterBuilder useDefaultStyle(Boolean useDefaultStyle)

Use the default style.Default is true.

参数:

useDefaultStyle -

返回:

automaticMergeHead

public ExcelWriterBuilder automaticMergeHead(Boolean automaticMergeHead)

Whether to automatically merge headers.Default is true.

参数:

automaticMergeHead -

返回:

password

public ExcelWriterBuilder password(String password)

Whether the encryption.

WARRING:Encryption is when the entire file is read into memory, so it is very memory intensive.

参数:

password -

返回:

inMemory

public ExcelWriterBuilder inMemory(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.

excludeColumnIndexes

public ExcelWriterBuilder excludeColumnIndexes(Collection<Integer> excludeColumnIndexes)

Ignore the custom columns.

excludeColumnFiledNames

public ExcelWriterBuilder excludeColumnFiledNames(Collection<String> excludeColumnFiledNames)

Ignore the custom columns.

includeColumnIndexes

public ExcelWriterBuilder includeColumnIndexes(Collection<Integer> includeColumnIndexes)

Only output the custom columns.

includeColumnFiledNames

public ExcelWriterBuilder includeColumnFiledNames(Collection<String> includeColumnFiledNames)

Only output the custom columns.

writeExcelOnException

public ExcelWriterBuilder writeExcelOnException(Boolean writeExcelOnException)

Excel is also written in the event of an exception being thrown.The default false.

convertAllFiled

@Deprecated
public ExcelWriterBuilder convertAllFiled(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 -

返回:

registerConverter

public ExcelWriterBuilder registerConverter(Converter converter)

Custom type conversions override the default.

参数:

converter -

返回:

registerWriteHandler

public ExcelWriterBuilder registerWriteHandler(WriteHandler writeHandler)

Custom write handler

参数:

writeHandler -

返回:

excelType

public ExcelWriterBuilder excelType(ExcelTypeEnum excelType)

file

public ExcelWriterBuilder file(OutputStream outputStream)

file

public ExcelWriterBuilder file(File outputFile)

file

public ExcelWriterBuilder file(String outputPathName)

withTemplate

public ExcelWriterBuilder withTemplate(InputStream templateInputStream)

withTemplate

public ExcelWriterBuilder withTemplate(File templateFile)

withTemplate

public ExcelWriterBuilder withTemplate(String pathName)

registerWriteHandler

@Deprecated
public ExcelWriterBuilder registerWriteHandler(WriteHandler writeHandler)

已过时。 please use WriteHandler

Write handler

build

public ExcelWriter build()

sheet

public ExcelWriterSheetBuilder sheet()

sheet

public ExcelWriterSheetBuilder sheet(Integer sheetNo)

sheet

public ExcelWriterSheetBuilder sheet(String sheetName)

sheet

public ExcelWriterSheetBuilder sheet(Integer sheetNo,
                                     String sheetName)