cn.idev.excel.write.builder

Class CsvWriterBuilder

java.lang.Object

cn.idev.excel.metadata.AbstractParameterBuilder<T,C>

cn.idev.excel.write.builder.AbstractExcelWriterParameterBuilder<CsvWriterBuilder,WriteSheet>

cn.idev.excel.write.builder.CsvWriterBuilder

public class CsvWriterBuilder
extends AbstractExcelWriterParameterBuilder<CsvWriterBuilder,WriteSheet>

Builder for CSV file writing

Constructor Summary

Constructors

Constructor and Description
CsvWriterBuilder(WriteWorkbook writeWorkbook)

Method Summary

Modifier and Type	Method and Description
CsvWriterBuilder	delimiter(String delimiter) Sets the delimiter character
void	doWrite(Collection<?> data)
void	doWrite(Supplier<Collection<?>> supplier)
CsvWriterBuilder	escape(Character escape) Sets the escape character.
CsvWriterBuilder	nullString(String nullString) Sets the null string
protected WriteSheet	parameter() Get parameter
CsvWriterBuilder	quote(Character quote) Sets the quote character
CsvWriterBuilder	quote(Character quote, org.apache.commons.csv.QuoteMode quoteMode) Sets the quote character and the quoting behavior
CsvWriterBuilder	recordSeparator(String recordSeparator) Sets the line separator

Methods inherited from class cn.idev.excel.write.builder.AbstractExcelWriterParameterBuilder

automaticMergeHead, excludeColumnFieldNames, excludeColumnFiledNames, excludeColumnIndexes, includeColumnFieldNames, includeColumnFiledNames, includeColumnIndexes, needHead, orderByIncludeColumn, registerWriteHandler, relativeHeadRowIndex, useDefaultStyle

Methods inherited from class cn.idev.excel.metadata.AbstractParameterBuilder

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvWriterBuilder

public CsvWriterBuilder(WriteWorkbook writeWorkbook)

Method Detail

delimiter

public CsvWriterBuilder delimiter(String delimiter)

Sets the delimiter character

Parameters:

delimiter - the delimiter character

Returns:

Returns a CsvWriterBuilder object, enabling method chaining

quote

public CsvWriterBuilder quote(Character quote)

Sets the quote character

Parameters:

quote - the quote character

Returns:

Returns a CsvWriterBuilder object, enabling method chaining

quote

public CsvWriterBuilder quote(Character quote,
                              org.apache.commons.csv.QuoteMode quoteMode)

Sets the quote character and the quoting behavior

Parameters:

quote - the quote character

quoteMode - defines the quoting behavior

Returns:

Returns a CsvWriterBuilder object, enabling method chaining

recordSeparator

public CsvWriterBuilder recordSeparator(String recordSeparator)

Sets the line separator

Parameters:

recordSeparator - the line separator

Returns:

Returns a CsvWriterBuilder object, enabling method chaining

nullString

public CsvWriterBuilder nullString(String nullString)

Sets the null string

Parameters:

nullString - the String to convert to and from null

Returns:

Returns a CsvWriterBuilder object, enabling method chaining

escape

public CsvWriterBuilder escape(Character escape)

Sets the escape character.

Parameters:

escape - the Character used to escape special characters in values

Returns:

Returns a CsvWriterBuilder object, enabling method chaining

doWrite

public void doWrite(Collection<?> data)

doWrite

public void doWrite(Supplier<Collection<?>> supplier)

parameter

protected WriteSheet parameter()

Description copied from class: AbstractParameterBuilder

Get parameter

Specified by:

parameter in class AbstractParameterBuilder<CsvWriterBuilder,WriteSheet>

Returns: