com.alibaba.excel.write.builder

Class AbstractExcelWriterParameterBuilder<T extends AbstractExcelWriterParameterBuilder,C extends WriteBasicParameter>

java.lang.Object

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

com.alibaba.excel.write.builder.AbstractExcelWriterParameterBuilder<T,C>

Direct Known Subclasses:

ExcelWriterBuilder, ExcelWriterSheetBuilder, ExcelWriterTableBuilder

public abstract class AbstractExcelWriterParameterBuilder<T extends AbstractExcelWriterParameterBuilder,C extends WriteBasicParameter>
extends AbstractParameterBuilder<T,C>

Build ExcelBuilder

Author:

Jiaju Zhuang

Constructor Summary

Constructors

Constructor and Description
AbstractExcelWriterParameterBuilder()

Method Summary

Modifier and Type	Method and Description
T	automaticMergeHead(Boolean automaticMergeHead) Whether to automatically merge headers.Default is true.
T	excludeColumnFieldNames(Collection<String> excludeColumnFieldNames) Ignore the custom columns.
T	excludeColumnFiledNames(Collection<String> excludeColumnFieldNames) Deprecated. use excludeColumnFieldNames(Collection)
T	excludeColumnIndexes(Collection<Integer> excludeColumnIndexes) Ignore the custom columns.
T	includeColumnFieldNames(Collection<String> includeColumnFieldNames) Only output the custom columns.
T	includeColumnFiledNames(Collection<String> includeColumnFieldNames) Deprecated. use includeColumnFieldNames(Collection)
T	includeColumnIndexes(Collection<Integer> includeColumnIndexes) Only output the custom columns.
T	needHead(Boolean needHead) Need Head
T	orderByIncludeColumn(Boolean orderByIncludeColumn) Data will be order by includeColumnFieldNames(java.util.Collection<java.lang.String>) or includeColumnIndexes(java.util.Collection<java.lang.Integer>).
T	registerWriteHandler(WriteHandler writeHandler) Custom write handler
T	relativeHeadRowIndex(Integer relativeHeadRowIndex) Writes the head relative to the existing contents of the sheet.
T	useDefaultStyle(Boolean useDefaultStyle) Use the default style.Default is true.

Methods inherited from class com.alibaba.excel.metadata.AbstractParameterBuilder

autoTrim, filedCacheLocation, head, head, locale, parameter, registerConverter, self, use1904windowing

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExcelWriterParameterBuilder

public AbstractExcelWriterParameterBuilder()

Method Detail

relativeHeadRowIndex

public T relativeHeadRowIndex(Integer relativeHeadRowIndex)

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

Parameters:

relativeHeadRowIndex -

Returns:

needHead

public T needHead(Boolean needHead)

Need Head

registerWriteHandler

public T registerWriteHandler(WriteHandler writeHandler)

Custom write handler

Parameters:

writeHandler -

Returns:

useDefaultStyle

public T useDefaultStyle(Boolean useDefaultStyle)

Use the default style.Default is true.

Parameters:

useDefaultStyle -

Returns:

automaticMergeHead

public T automaticMergeHead(Boolean automaticMergeHead)

Whether to automatically merge headers.Default is true.

Parameters:

automaticMergeHead -

Returns:

excludeColumnIndexes

public T excludeColumnIndexes(Collection<Integer> excludeColumnIndexes)

Ignore the custom columns.

excludeColumnFiledNames

public T excludeColumnFiledNames(Collection<String> excludeColumnFieldNames)

Deprecated. use excludeColumnFieldNames(Collection)

Ignore the custom columns.

excludeColumnFieldNames

public T excludeColumnFieldNames(Collection<String> excludeColumnFieldNames)

Ignore the custom columns.

includeColumnIndexes

public T includeColumnIndexes(Collection<Integer> includeColumnIndexes)

Only output the custom columns.

includeColumnFiledNames

public T includeColumnFiledNames(Collection<String> includeColumnFieldNames)

Deprecated. use includeColumnFieldNames(Collection)

Only output the custom columns.

includeColumnFieldNames

public T includeColumnFieldNames(Collection<String> includeColumnFieldNames)

Only output the custom columns.

orderByIncludeColumn

public T orderByIncludeColumn(Boolean orderByIncludeColumn)

Data will be order by includeColumnFieldNames(java.util.Collection<java.lang.String>) or includeColumnIndexes(java.util.Collection<java.lang.Integer>). default is false.

Since:

3.3.0