org.ttzero.excel.entity

接口 IWorkbookWriter

所有超级接口:

AutoCloseable, Closeable, Storable

所有已知实现类:

CSVWorkbookWriter, XMLWorkbookWriter

public interface IWorkbookWriter
extends Storable, Closeable

工作薄输出协议，负责协调所有部件输出并组装所有零散的文件

作者:

guanquan.wang at 2019-04-22 16:00

另请参阅:

XMLWorkbookWriter, CSVWorkbookWriter

方法概要

限定符和类型	方法和说明
String	getSuffix() 获取最终的输出格式
IWorksheetWriter	getWorksheetWriter(Sheet sheet) 获取工作表输出协议
default Path	moveToPath(Path source, Path target, String defaultName) 移动文件到指定位置，如果已存在相同文件名则会在文件名后追回（n）以区分， n从1开始如果已存在（n）则新文件名为（n + 1） 例：目标文件夹已存在a.xlsx和b（5）.xlsx两个文件，添加一个名为a.xlsx的文件 因为a.xlsx已存在所以新文件另存为a（1）.xlsx，添加一个名为b.xlsx的文件则新文件另存为b（6）.xlsx
static Properties	pom() 获取pom配置相关信息
void	setWorkbook(Workbook workbook) 设置工作薄
default Path	writeBefore() 导入前的准备工作
default void	writeTo(File file) 将工作薄写到指定位置
void	writeTo(OutputStream os) 将工作薄写到指定流

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

writeTo

从接口继承的方法 java.io.Closeable

close

方法详细资料

setWorkbook

void setWorkbook(Workbook workbook)

设置工作薄

参数:

workbook - 工作薄

getSuffix

String getSuffix()

获取最终的输出格式

返回:

xlsx: excel07, xls: excel03

writeTo

void writeTo(OutputStream os)
      throws IOException

将工作薄写到指定流

参数:

os - 输出流

抛出:

IOException - if I/O error occur

writeTo

default void writeTo(File file)
              throws IOException

将工作薄写到指定位置

参数:

file - 目标文件

抛出:

IOException - if I/O error occur

getWorksheetWriter

IWorksheetWriter getWorksheetWriter(Sheet sheet)

获取工作表输出协议

参数:

sheet - 工作表

返回:

工作表输出协议

writeBefore

default Path writeBefore()
                  throws IOException

导入前的准备工作

返回:

临时文件路径

抛出:

IOException - if I/O error occur

moveToPath

default Path moveToPath(Path source,
                        Path target,
                        String defaultName)
                 throws IOException

移动文件到指定位置，如果已存在相同文件名则会在文件名后追回（n）以区分， n从1开始如果已存在（n）则新文件名为（n + 1）

例：目标文件夹已存在a.xlsx和b（5）.xlsx两个文件，添加一个名为a.xlsx的文件 因为a.xlsx已存在所以新文件另存为a（1）.xlsx，添加一个名为b.xlsx的文件则新文件另存为b（6）.xlsx

参数:

source - 源文件

target - 目标文件夹

defaultName - 目标文件名

返回:

另存为目标文件绝对路径

抛出:

IOException - if I/O error occur

pom

static Properties pom()

获取pom配置相关信息

返回:

general pom properties