org.ttzero.excel.entity.csv

类 CSVWorkbookWriter

java.lang.Object

org.ttzero.excel.entity.csv.CSVWorkbookWriter

所有已实现的接口:

Closeable, AutoCloseable, IWorkbookWriter, Storable

public class CSVWorkbookWriter
extends Object
implements IWorkbookWriter

Write data as Comma-Separated Values format

作者:

guanquan.wang at 2019-08-21 21:46

字段概要

字段

限定符和类型	字段和说明
protected Charset	charset Charset 默认UTF-8
protected org.slf4j.Logger	LOGGER LOGGER
protected Path	tmpPath 临时文件路径
protected boolean	withBom Write BOM header
protected Workbook	workbook

构造器概要

构造器

构造器和说明
CSVWorkbookWriter()
CSVWorkbookWriter(Workbook workbook)
CSVWorkbookWriter(Workbook workbook, boolean withBom)

方法概要

限定符和类型	方法和说明
void	close()
protected Path	createTemp()
String	getSuffix() The Comma-Separated Values format suffix
IWorksheetWriter	getWorksheetWriter(Sheet sheet) 获取工作表输出协议
protected void	moveToPath(Path source, Path target)
CSVWorkbookWriter	setCharset(Charset charset) 设置字符集
void	setWorkbook(Workbook workbook) 设置工作薄
Path	writeBefore() 导入前的准备工作
void	writeTo(OutputStream os) Write to OutputStream
void	writeTo(Path root) 写入指定路径，传入的参数可以是一个文件也可以是文件夹，需要在实现类具体处理

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

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

从接口继承的方法 org.ttzero.excel.entity.IWorkbookWriter

moveToPath, pom, writeTo

字段详细资料

LOGGER

protected org.slf4j.Logger LOGGER

LOGGER

workbook

protected Workbook workbook

withBom

protected boolean withBom

Write BOM header

charset

protected Charset charset

Charset 默认UTF-8

tmpPath

protected Path tmpPath

临时文件路径

构造器详细资料

CSVWorkbookWriter

public CSVWorkbookWriter()

CSVWorkbookWriter

public CSVWorkbookWriter(Workbook workbook)

CSVWorkbookWriter

public CSVWorkbookWriter(Workbook workbook,
                         boolean withBom)

方法详细资料

setWorkbook

public void setWorkbook(Workbook workbook)

从接口复制的说明: IWorkbookWriter

设置工作薄

指定者:

setWorkbook 在接口中 IWorkbookWriter

参数:

workbook - 工作薄

getSuffix

public String getSuffix()

The Comma-Separated Values format suffix

指定者:

getSuffix 在接口中 IWorkbookWriter

返回:

const value '.csv'

writeTo

public void writeTo(OutputStream os)
             throws IOException

Write to OutputStream

指定者:

writeTo 在接口中 IWorkbookWriter

参数:

os - the output stream

抛出:

IOException - if io error occur

writeTo

public void writeTo(Path root)
             throws IOException

从接口复制的说明: Storable

写入指定路径，传入的参数可以是一个文件也可以是文件夹，需要在实现类具体处理

指定者:

writeTo 在接口中 Storable

参数:

root - 父级文件夹或文件绝对路径

抛出:

IOException - 写失败异常

moveToPath

protected void moveToPath(Path source,
                          Path target)
                   throws IOException

抛出:

IOException

writeBefore

public Path writeBefore()
                 throws IOException

从接口复制的说明: IWorkbookWriter

导入前的准备工作

指定者:

writeBefore 在接口中 IWorkbookWriter

返回:

临时文件路径

抛出:

IOException - if I/O error occur

createTemp

protected Path createTemp()
                   throws IOException,
                          ExcelWriteException

抛出:

IOException

ExcelWriteException

close

public void close()

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

setCharset

public CSVWorkbookWriter setCharset(Charset charset)

设置字符集

参数:

charset - Charset

返回:

当前Writer

getWorksheetWriter

public IWorksheetWriter getWorksheetWriter(Sheet sheet)

从接口复制的说明: IWorkbookWriter

获取工作表输出协议

指定者:

getWorksheetWriter 在接口中 IWorkbookWriter

参数:

sheet - 工作表

返回:

工作表输出协议