org.dromara.hutool.poi.csv

Class CsvWriteConfig

java.lang.Object

org.dromara.hutool.poi.csv.CsvConfig<CsvWriteConfig>

org.dromara.hutool.poi.csv.CsvWriteConfig

All Implemented Interfaces:

Serializable

public class CsvWriteConfig
extends CsvConfig<CsvWriteConfig>
implements Serializable

CSV写出配置项

Author:

looly

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	alwaysDelimitText 是否始终使用文本分隔符，文本包装符，默认false，按需添加
protected boolean	ddeSafe 是否使用安全模式，对可能存在DDE攻击的内容进行替换
protected boolean	endingLineBreak 文件末尾是否添加换行符 按照https://datatracker.ietf.org/doc/html/rfc4180#section-2 规范，末尾换行符可有可无。
protected char[]	lineDelimiter 换行符

Fields inherited from class org.dromara.hutool.poi.csv.CsvConfig

commentCharacter, fieldSeparator, headerAlias, textDelimiter

Constructor Summary

Constructors

Constructor and Description
CsvWriteConfig()

Method Summary

Modifier and Type	Method and Description
static CsvWriteConfig	defaultConfig() 默认配置
CsvWriteConfig	setAlwaysDelimitText(boolean alwaysDelimitText) 设置是否始终使用文本分隔符，文本包装符，默认false，按需添加
CsvWriteConfig	setDdeSafe(boolean ddeSafe) 设置是否动态数据交换安全，使用文本包装符包裹可能存在DDE攻击的内容 见：https://blog.csdn.net/weixin_41924764/article/details/108665746
CsvWriteConfig	setEndingLineBreak(boolean endingLineBreak) 文件末尾是否添加换行符 按照https://datatracker.ietf.org/doc/html/rfc4180#section-2 规范，末尾换行符可有可无。
CsvWriteConfig	setLineDelimiter(char[] lineDelimiter) 设置换行符

Methods inherited from class org.dromara.hutool.poi.csv.CsvConfig

addHeaderAlias, disableComment, removeHeaderAlias, setCommentCharacter, setFieldSeparator, setHeaderAlias, setTextDelimiter

Methods inherited from class java.lang.Object

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

Field Detail

alwaysDelimitText

protected boolean alwaysDelimitText

是否始终使用文本分隔符，文本包装符，默认false，按需添加

lineDelimiter

protected char[] lineDelimiter

换行符

ddeSafe

protected boolean ddeSafe

是否使用安全模式，对可能存在DDE攻击的内容进行替换

endingLineBreak

protected boolean endingLineBreak

文件末尾是否添加换行符
按照https://datatracker.ietf.org/doc/html/rfc4180#section-2 规范，末尾换行符可有可无。

Constructor Detail

CsvWriteConfig

public CsvWriteConfig()

Method Detail

defaultConfig

public static CsvWriteConfig defaultConfig()

默认配置

Returns:

默认配置

setAlwaysDelimitText

public CsvWriteConfig setAlwaysDelimitText(boolean alwaysDelimitText)

设置是否始终使用文本分隔符，文本包装符，默认false，按需添加

Parameters:

alwaysDelimitText - 是否始终使用文本分隔符，文本包装符，默认false，按需添加

Returns:

this

setLineDelimiter

public CsvWriteConfig setLineDelimiter(char[] lineDelimiter)

设置换行符

Parameters:

lineDelimiter - 换行符

Returns:

this

setDdeSafe

public CsvWriteConfig setDdeSafe(boolean ddeSafe)

设置是否动态数据交换安全，使用文本包装符包裹可能存在DDE攻击的内容
见：https://blog.csdn.net/weixin_41924764/article/details/108665746

Parameters:

ddeSafe - dde安全

Returns:

this

setEndingLineBreak

public CsvWriteConfig setEndingLineBreak(boolean endingLineBreak)

文件末尾是否添加换行符
按照https://datatracker.ietf.org/doc/html/rfc4180#section-2 规范，末尾换行符可有可无。

Parameters:

endingLineBreak - 文件末尾是否添加换行符

Returns:

this