IWorksheetWriter (Excel Write/Read Framework 0.5.26 API)

所有超级接口:

AutoCloseable, Cloneable, Closeable, Storable

所有已知实现类:

CSVWorksheetWriter, XMLWorksheetWriter
```
public interface IWorksheetWriter
extends Closeable, Cloneable, Storable
```
工作表输出协议，负责将工作表Sheet格式化输出，它会循环调用Sheet.nextBlock() 方法获取数据并写入磁盘直到RowBlock.isEOF()返回EOF标记为止，整个过程只有一个 RowBlock行块常驻内存，一个RowBlock行块默认包含32个Row行，这样可以保证较小的内存开销。
通过getRowLimit()和getColumnLimit()可以限制行列数，xlsx格式默认的行列限制分别是 1048576和65536，可以重置行限制以提前触发分页，例：getRowLimit返回10000，则工作表Worksheet每1万行进行一次分页

作者:

guanquan.wang at 2019-04-22 17:23

另请参阅:

XMLWorksheetWriter, CSVWorksheetWriter

方法概要

所有方法静态方法实例方法抽象方法默认方法已过时的方法
限定符和类型	方法和说明
`IWorksheetWriter`	`clone()` 复制工作表输出协议
`default ICellValueAndStyle`	`getCellValueAndStyle()` 获取数据样式转换器，可以根据不同输出协议制定转换器
`int`	`getColumnLimit()` 获取最大列上限，随输出格式而定
`String`	`getFileSuffix()` 获取扩展名，随输出协议而定
`int`	`getRowLimit()` 获取最大行上限，随输出格式而定
`static boolean`	`isBigDecimal(Class<?> clazz)` 判断是否为`BigDecimal`类型
`static boolean`	`isBool(Class<?> clazz)` 判断是否为`boolean`或`Boolean`类型
`static boolean`	`isChar(Class<?> clazz)` 判断是否为`char` 或 `Character`类型
`static boolean`	`isDate(Class<?> clazz)` 判断是否为`Date`类型
`static boolean`	`isDateTime(Class<?> clazz)` 判断是否为`Timestamp`类型
`static boolean`	`isDouble(Class<?> clazz)` 判断是否为双精度浮点类型
`static boolean`	`isFloat(Class<?> clazz)` 判断是否为单精度浮点类型
`static boolean`	`isInt(Class<?> clazz)` 判断是否为`int, char, byte or short`或包装类型
`static boolean`	`isLocalDate(Class<?> clazz)` 判断是否为`LocalDate`类型
`static boolean`	`isLocalDateTime(Class<?> clazz)` 判断是否为`LocalDateTime`类型
`static boolean`	`isLocalTime(Class<?> clazz)` 判断是否为`LocalTime`类型
`static boolean`	`isLong(Class<?> clazz)` 判断是否为`long`或`Long`类型
`static boolean`	`isShort(Class<?> clazz)` 判断是否为`short`或`Short`类型
`static boolean`	`isString(Class<?> clazz)` 判断是否为`String`类型
`static boolean`	`isTime(Class<?> clazz)` 判断是否为`Time`类型
`IWorksheetWriter`	`setWorksheet(Sheet sheet)` 设置工作表
`default void`	`writeData(RowBlock rowBlock)` PUSH模式推行数据
`default void`	`writePicture(Picture picture)` 添加图片
`default void`	`writeTo(Path path, Supplier<RowBlock> supplier)` 已过时。未使用，即将移除

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

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

- 方法详细资料
  - getRowLimit
```
int getRowLimit()
```
    获取最大行上限，随输出格式而定
    
    返回:
    
    行最大上限值
  - getColumnLimit
```
int getColumnLimit()
```
    获取最大列上限，随输出格式而定
    
    返回:
    
    列最大上限值
  - writeTo
```
@Deprecated
default void writeTo(Path path,
                                 Supplier<RowBlock> supplier)
                          throws IOException
```
    已过时。未使用，即将移除
    
    数据输出到指定位置
    
    参数:
    
    path - 保存位置
    
    supplier - 数据提供方
    
    抛出:
    
    IOException - if I/O error occur
  - setWorksheet
```
IWorksheetWriter setWorksheet(Sheet sheet)
```
    设置工作表
    
    参数:
    
    sheet - 工作表Sheet
    
    返回:
    
    当前输出协议
  - clone
```
IWorksheetWriter clone()
```
    复制工作表输出协议
    
    返回:
    
    IWorksheetWriter
  - getFileSuffix
```
String getFileSuffix()
```
    获取扩展名，随输出协议而定
    
    返回:
    
    扩展名
  - writePicture
```
default void writePicture(Picture picture)
                   throws IOException
```
    添加图片
    
    参数:
    
    picture - 可写图片
    
    抛出:
    
    IOException - if I/O error occur
  - writeData
```
default void writeData(RowBlock rowBlock)
                throws IOException
```
    PUSH模式推行数据
    
    参数:
    
    rowBlock - 行块
    
    抛出:
    
    IOException - if I/O error occur
  - getCellValueAndStyle
```
default ICellValueAndStyle getCellValueAndStyle()
```
    获取数据样式转换器，可以根据不同输出协议制定转换器
    
    返回:
    
    数据样式转换器
  - isDate
```
static boolean isDate(Class<?> clazz)
```
    判断是否为Date类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool
  - isDateTime
```
static boolean isDateTime(Class<?> clazz)
```
    判断是否为Timestamp类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool
  - isInt
```
static boolean isInt(Class<?> clazz)
```
    判断是否为int, char, byte or short或包装类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool
  - isShort
```
static boolean isShort(Class<?> clazz)
```
    判断是否为short或Short类型
    
    参数:
    
    clazz - the class
    
    返回:
    
    bool
  - isLong
```
static boolean isLong(Class<?> clazz)
```
    判断是否为long或Long类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool
  - isFloat
```
static boolean isFloat(Class<?> clazz)
```
    判断是否为单精度浮点类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool
  - isDouble
```
static boolean isDouble(Class<?> clazz)
```
    判断是否为双精度浮点类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool
  - isBool
```
static boolean isBool(Class<?> clazz)
```
    判断是否为boolean或Boolean类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool
  - isString
```
static boolean isString(Class<?> clazz)
```
    判断是否为String类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool
  - isChar
```
static boolean isChar(Class<?> clazz)
```
    判断是否为char 或 Character类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool
  - isBigDecimal
```
static boolean isBigDecimal(Class<?> clazz)
```
    判断是否为BigDecimal类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool
  - isLocalDate
```
static boolean isLocalDate(Class<?> clazz)
```
    判断是否为LocalDate类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool
  - isLocalDateTime
```
static boolean isLocalDateTime(Class<?> clazz)
```
    判断是否为LocalDateTime类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool
  - isTime
```
static boolean isTime(Class<?> clazz)
```
    判断是否为Time类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool
  - isLocalTime
```
static boolean isLocalTime(Class<?> clazz)
```
    判断是否为LocalTime类型
    
    参数:
    
    clazz - the type
    
    返回:
    
    bool

接口 IWorksheetWriter

方法概要

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

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

方法详细资料

getRowLimit

getColumnLimit

writeTo

setWorksheet

clone

getFileSuffix

writePicture

writeData

getCellValueAndStyle

isDate

isDateTime

isInt

isShort

isLong

isFloat

isDouble

isBool

isString

isChar

isBigDecimal

isLocalDate

isLocalDateTime

isTime

isLocalTime