cn.orionsec.kit.office.csv.writer

Class BaseCsvWriter<K,V>

java.lang.Object

cn.orionsec.kit.office.csv.writer.BaseCsvWriter<K,V>

All Implemented Interfaces:

SafeCloseable, SafeFlushable, Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

CsvArrayWriter, CsvBeanWriter, CsvLambdaWriter, CsvMapWriter

public abstract class BaseCsvWriter<K,V>
extends Object
implements SafeCloseable, SafeFlushable

csv 导出器 基类

Since:

2021/1/22 17:53

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields

Modifier and Type	Field and Description
protected int	capacity 数组容量
protected Map<K,Object>	defaultValue 默认值
protected Map<Integer,K>	mapping 映射 key: column value: valueKey
protected int	maxColumnIndex 映射最大列索引
protected boolean	skipNullRows 是否跳过空行
protected CsvWriter	writer writer

Constructor Summary

Constructors

Constructor and Description
BaseCsvWriter(CsvWriter writer)

Method Summary

Modifier and Type	Method and Description
BaseCsvWriter<K,V>	addComment(String comment) 添加备注
BaseCsvWriter<K,V>	addComments(Collection<String> comments) 添加备注
BaseCsvWriter<K,V>	addRow(V row) 添加行
BaseCsvWriter<K,V>	addRows(Collection<V> list) 添加行
BaseCsvWriter<K,V>	capacity(int capacity) 设置数组容量
protected String[]	capacityStore() 开辟数组
void	close() 安全关闭
BaseCsvWriter<K,V>	defaultValue(K k, Object value) 默认值
void	flush() 安全刷新以及强制写出
int	getCapacity()
CsvWriterOption	getOption()
CsvWriter	getWriter()
BaseCsvWriter<K,V>	headers(String... headers) 添加表头
BaseCsvWriter<K,V>	mapping(int column, K k)
BaseCsvWriter<K,V>	mapping(int column, K k, Object defaultValue) 映射
protected abstract String[]	parseRow(V row) 解析行
BaseCsvWriter<K,V>	skip() 跳过一行
BaseCsvWriter<K,V>	skip(int i) 跳过一行
BaseCsvWriter<K,V>	skipNullRows(boolean skip) 跳过空行

Methods inherited from class java.lang.Object

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

Field Detail

writer

protected final CsvWriter writer

writer

skipNullRows

protected boolean skipNullRows

是否跳过空行

defaultValue

protected final Map<K,Object> defaultValue

默认值

capacity

protected int capacity

数组容量

maxColumnIndex

protected int maxColumnIndex

映射最大列索引

mapping

protected Map<Integer,K> mapping

映射 key: column value: valueKey

Constructor Detail

BaseCsvWriter

public BaseCsvWriter(CsvWriter writer)

Method Detail

skip

public BaseCsvWriter<K,V> skip()

跳过一行

Returns:

this

skip

public BaseCsvWriter<K,V> skip(int i)

跳过一行

Parameters:

i - 行

Returns:

this

capacity

public BaseCsvWriter<K,V> capacity(int capacity)

设置数组容量

Parameters:

capacity - capacity

Returns:

this

skipNullRows

public BaseCsvWriter<K,V> skipNullRows(boolean skip)

跳过空行

Parameters:

skip - 是否跳过

Returns:

this

mapping

public BaseCsvWriter<K,V> mapping(int column,
                                  K k)

mapping

public BaseCsvWriter<K,V> mapping(int column,
                                  K k,
                                  Object defaultValue)

映射

Parameters:

column - column

k - valueKey

defaultValue - defaultValue

Returns:

this

defaultValue

public BaseCsvWriter<K,V> defaultValue(K k,
                                       Object value)

默认值

Parameters:

k - k

value - value

Returns:

this

headers

public BaseCsvWriter<K,V> headers(String... headers)

添加表头

Parameters:

headers - 表头

Returns:

this

addRows

public BaseCsvWriter<K,V> addRows(Collection<V> list)

添加行

Parameters:

list - 行

Returns:

this

addRow

public BaseCsvWriter<K,V> addRow(V row)

添加行

Parameters:

row - 行

Returns:

this

addComments

public BaseCsvWriter<K,V> addComments(Collection<String> comments)

添加备注

Parameters:

comments - comments

Returns:

this

addComment

public BaseCsvWriter<K,V> addComment(String comment)

添加备注

Parameters:

comment - comment

Returns:

this

capacityStore

protected String[] capacityStore()

开辟数组

Returns:

开辟数组

parseRow

protected abstract String[] parseRow(V row)

解析行

Parameters:

row - 行

Returns:

String[]

flush

public void flush()

Description copied from interface: SafeFlushable

安全刷新以及强制写出

Specified by:

flush in interface SafeFlushable

Specified by:

flush in interface Flushable

close

public void close()

Description copied from interface: SafeCloseable

安全关闭

Specified by:

close in interface SafeCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getWriter

public CsvWriter getWriter()

getOption

public CsvWriterOption getOption()

getCapacity

public int getCapacity()