org.dromara.hutool.poi.csv

类 CsvConfig<T extends CsvConfig<T>>

java.lang.Object

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

类型参数:

T - 继承子类类型，用于this返回

所有已实现的接口:

Serializable

直接已知子类:

CsvReadConfig, CsvWriteConfig

public class CsvConfig<T extends CsvConfig<T>>
extends Object
implements Serializable

CSV基础配置项，此配置项可用于读取和写出CSV，定义了包括字段分隔符、文本包装符等符号

作者:

looly

从以下版本开始:

4.0.5

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
protected Character	commentCharacter 注释符号，用于区分注释行，默认'#'
protected char	fieldSeparator 字段分隔符，默认逗号','
protected Map<String,String>	headerAlias 标题别名
protected char	textDelimiter 文本包装符，默认双引号'"'

构造器概要

构造器

构造器和说明
CsvConfig()

方法概要

限定符和类型	方法和说明
T	addHeaderAlias(String header, String alias) 增加标题别名
T	disableComment() 设置注释无效 当写出CSV时，CsvWriter.writeComment(String)将抛出异常 当读取CSV时，注释行按照正常行读取
T	removeHeaderAlias(String header) 去除标题别名
T	setCommentCharacter(Character commentCharacter) 设置 注释符号，用于区分注释行，null表示忽略注释
T	setFieldSeparator(char fieldSeparator) 设置字段分隔符，默认逗号','
T	setHeaderAlias(Map<String,String> headerAlias) 设置标题行的别名Map
T	setTextDelimiter(char textDelimiter) 设置 文本分隔符，文本包装符，默认双引号'"'

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

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

字段详细资料

fieldSeparator

protected char fieldSeparator

字段分隔符，默认逗号','

textDelimiter

protected char textDelimiter

文本包装符，默认双引号'"'

commentCharacter

protected Character commentCharacter

注释符号，用于区分注释行，默认'#'

headerAlias

protected Map<String,String> headerAlias

标题别名

构造器详细资料

CsvConfig

public CsvConfig()

方法详细资料

setFieldSeparator

public T setFieldSeparator(char fieldSeparator)

设置字段分隔符，默认逗号','

参数:

fieldSeparator - 字段分隔符，默认逗号','

返回:

this

setTextDelimiter

public T setTextDelimiter(char textDelimiter)

设置 文本分隔符，文本包装符，默认双引号'"'

参数:

textDelimiter - 文本分隔符，文本包装符，默认双引号'"'

返回:

this

disableComment

public T disableComment()

设置注释无效
当写出CSV时，CsvWriter.writeComment(String)将抛出异常
当读取CSV时，注释行按照正常行读取

返回:

this

从以下版本开始:

5.7.14

setCommentCharacter

public T setCommentCharacter(Character commentCharacter)

设置 注释符号，用于区分注释行，null表示忽略注释

参数:

commentCharacter - 注释符号，用于区分注释行

返回:

this

从以下版本开始:

5.5.7

setHeaderAlias

public T setHeaderAlias(Map<String,String> headerAlias)

设置标题行的别名Map

参数:

headerAlias - 别名Map

返回:

this

从以下版本开始:

5.7.10

addHeaderAlias

public T addHeaderAlias(String header,
                        String alias)

增加标题别名

参数:

header - 标题

alias - 别名

返回:

this

从以下版本开始:

5.7.10

removeHeaderAlias

public T removeHeaderAlias(String header)

去除标题别名

参数:

header - 标题

返回:

this

从以下版本开始:

5.7.10