com.alibaba.excel.write.builder

类 ExcelWriterBuilder

java.lang.Object

com.alibaba.excel.metadata.AbstractParameterBuilder<T,C>

com.alibaba.excel.write.builder.AbstractExcelWriterParameterBuilder<ExcelWriterBuilder,WriteWorkbook>

com.alibaba.excel.write.builder.ExcelWriterBuilder

public class ExcelWriterBuilder
extends AbstractExcelWriterParameterBuilder<ExcelWriterBuilder,WriteWorkbook>

Build ExcelBuilder

作者:

Jiaju Zhuang

构造器概要

构造器

构造器和说明
ExcelWriterBuilder()

方法概要

限定符和类型	方法和说明
ExcelWriterBuilder	autoCloseStream(Boolean autoCloseStream) Default 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	file(File outputFile)
ExcelWriterBuilder	file(OutputStream outputStream)
ExcelWriterBuilder	file(String outputPathName)
ExcelWriterBuilder	inMemory(Boolean inMemory) Write excel in memory.
protected WriteWorkbook	parameter() Get parameter
ExcelWriterBuilder	password(String password) Whether the encryption.
ExcelWriterBuilder	registerWriteHandler(WriteHandler writeHandler) 已过时。 please use WriteHandler
ExcelWriterSheetBuilder	sheet()
ExcelWriterSheetBuilder	sheet(Integer sheetNo)
ExcelWriterSheetBuilder	sheet(Integer sheetNo, String sheetName)
ExcelWriterSheetBuilder	sheet(String sheetName)
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.

从类继承的方法 com.alibaba.excel.write.builder.AbstractExcelWriterParameterBuilder

automaticMergeHead, excludeColumnFiledNames, excludeColumnIndexes, includeColumnFiledNames, includeColumnIndexes, needHead, registerWriteHandler, relativeHeadRowIndex, useDefaultStyle

从类继承的方法 com.alibaba.excel.metadata.AbstractParameterBuilder

autoTrim, head, head, locale, registerConverter, self, use1904windowing

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

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

构造器详细资料

ExcelWriterBuilder

public ExcelWriterBuilder()

方法详细资料

autoCloseStream

public ExcelWriterBuilder autoCloseStream(Boolean autoCloseStream)

Default true

参数:

autoCloseStream -

返回:

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.

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 -

返回:

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)

parameter

protected WriteWorkbook parameter()

从类复制的说明: AbstractParameterBuilder

Get parameter

指定者:

parameter 在类中 AbstractParameterBuilder<ExcelWriterBuilder,WriteWorkbook>

返回: