org.dromara.hutool.poi.csv

Class CsvConfig<T extends CsvConfig<T>>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CsvReadConfig, CsvWriteConfig

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

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

Since:

4.0.5

Author:

looly

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Character	commentCharacter 注释符号，用于区分注释行，默认'#'
protected char	fieldSeparator 字段分隔符，默认逗号','
protected Map<String,String>	headerAlias 标题别名
protected char	textDelimiter 文本包装符，默认双引号'"'

Constructor Summary

Constructors

Constructor and Description
CsvConfig()

Method Summary

Modifier and Type	Method and Description
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) 设置 文本分隔符，文本包装符，默认双引号'"'

Methods inherited from class java.lang.Object

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

Field Detail

fieldSeparator

protected char fieldSeparator

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

textDelimiter

protected char textDelimiter

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

commentCharacter

protected Character commentCharacter

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

headerAlias

protected Map<String,String> headerAlias

标题别名

Constructor Detail

CsvConfig

public CsvConfig()

Method Detail

setFieldSeparator

public T setFieldSeparator(char fieldSeparator)

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

Parameters:

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

Returns:

this

setTextDelimiter

public T setTextDelimiter(char textDelimiter)

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

Parameters:

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

Returns:

this

disableComment

public T disableComment()

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

Returns:

this

Since:

5.7.14

setCommentCharacter

public T setCommentCharacter(Character commentCharacter)

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

Parameters:

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

Returns:

this

Since:

5.5.7

setHeaderAlias

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

设置标题行的别名Map

Parameters:

headerAlias - 别名Map

Returns:

this

Since:

5.7.10

addHeaderAlias

public T addHeaderAlias(String header,
                        String alias)

增加标题别名

Parameters:

header - 标题

alias - 别名

Returns:

this

Since:

5.7.10

removeHeaderAlias

public T removeHeaderAlias(String header)

去除标题别名

Parameters:

header - 标题

Returns:

this

Since:

5.7.10