org.dromara.hutool.poi.csv

Class CsvReadConfig

java.lang.Object

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

org.dromara.hutool.poi.csv.CsvReadConfig

All Implemented Interfaces:

Serializable

public class CsvReadConfig
extends CsvConfig<CsvReadConfig>
implements Serializable

CSV读取配置项

Author:

looly

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	beginLineNo 定义开始的行（包括），此处为原始文件行号
protected long	endLineNo 结束的行（包括），此处为原始文件行号
protected boolean	errorOnDifferentFieldCount 每行字段个数不同时是否抛出异常，默认false
protected long	headerLineNo 指定标题行号，-1表示无标题行
protected boolean	skipEmptyRows 是否跳过空白行，默认true
protected boolean	trimField 每个字段是否去除两边空白符

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

commentCharacter, fieldSeparator, headerAlias, textDelimiter

Constructor Summary

Constructors

Constructor and Description
CsvReadConfig()

Method Summary

Modifier and Type	Method and Description
static CsvReadConfig	of() 默认配置
CsvReadConfig	setBeginLineNo(long beginLineNo) 设置开始的行（包括），默认0，此处为原始文件行号
CsvReadConfig	setContainsHeader(boolean containsHeader) 设置是否首行做为标题行，默认false 当设置为true时，默认标题行号是beginLineNo，false为-1，表示无行号
CsvReadConfig	setEndLineNo(long endLineNo) 设置结束的行（包括），默认不限制，此处为原始文件行号
CsvReadConfig	setErrorOnDifferentFieldCount(boolean errorOnDifferentFieldCount) 设置每行字段个数不同时是否抛出异常，默认false
CsvReadConfig	setHeaderLineNo(long headerLineNo) 设置标题行行号，默认-1，表示无标题行
CsvReadConfig	setSkipEmptyRows(boolean skipEmptyRows) 设置是否跳过空白行，默认true
CsvReadConfig	setTrimField(boolean trimField) 设置每个字段是否去除两边空白符 如果字段以CsvConfig.textDelimiter包围，则保留两边空格

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

headerLineNo

protected long headerLineNo

指定标题行号，-1表示无标题行

skipEmptyRows

protected boolean skipEmptyRows

是否跳过空白行，默认true

errorOnDifferentFieldCount

protected boolean errorOnDifferentFieldCount

每行字段个数不同时是否抛出异常，默认false

beginLineNo

protected long beginLineNo

定义开始的行（包括），此处为原始文件行号

endLineNo

protected long endLineNo

结束的行（包括），此处为原始文件行号

trimField

protected boolean trimField

每个字段是否去除两边空白符

Constructor Detail

CsvReadConfig

public CsvReadConfig()

Method Detail

of

public static CsvReadConfig of()

默认配置

Returns:

默认配置

setContainsHeader

public CsvReadConfig setContainsHeader(boolean containsHeader)

设置是否首行做为标题行，默认false
当设置为true时，默认标题行号是beginLineNo，false为-1，表示无行号

Parameters:

containsHeader - 是否首行做为标题行，默认false

Returns:

this

See Also:

setHeaderLineNo(long)

setHeaderLineNo

public CsvReadConfig setHeaderLineNo(long headerLineNo)

设置标题行行号，默认-1，表示无标题行

Parameters:

headerLineNo - 标题行行号，-1表示无标题行

Returns:

this

Since:

5.7.23

setSkipEmptyRows

public CsvReadConfig setSkipEmptyRows(boolean skipEmptyRows)

设置是否跳过空白行，默认true

Parameters:

skipEmptyRows - 是否跳过空白行，默认true

Returns:

this

setErrorOnDifferentFieldCount

public CsvReadConfig setErrorOnDifferentFieldCount(boolean errorOnDifferentFieldCount)

设置每行字段个数不同时是否抛出异常，默认false

Parameters:

errorOnDifferentFieldCount - 每行字段个数不同时是否抛出异常，默认false

Returns:

this

setBeginLineNo

public CsvReadConfig setBeginLineNo(long beginLineNo)

设置开始的行（包括），默认0，此处为原始文件行号

Parameters:

beginLineNo - 开始的行号（包括）

Returns:

this

Since:

5.7.4

setEndLineNo

public CsvReadConfig setEndLineNo(long endLineNo)

设置结束的行（包括），默认不限制，此处为原始文件行号

Parameters:

endLineNo - 结束的行号（包括）

Returns:

this

Since:

5.7.4

setTrimField

public CsvReadConfig setTrimField(boolean trimField)

设置每个字段是否去除两边空白符
如果字段以CsvConfig.textDelimiter包围，则保留两边空格

Parameters:

trimField - 去除两边空白符

Returns:

this

Since:

5.7.13