CSVWorksheetWriter (Excel Write/Read Framework 0.5.26 API)

java.lang.Object
- org.ttzero.excel.entity.csv.CSVWorksheetWriter

所有已实现的接口:

Closeable, AutoCloseable, Cloneable, IWorksheetWriter, Storable
```
public class CSVWorksheetWriter
extends Object
implements IWorksheetWriter
```
作者:

guanquan.wang at 2019-08-21 22:19

字段概要

字段
限定符和类型	字段和说明
`protected Charset`	`charset`
`protected char`	`delimiter` Delimiter char
`protected BiConsumer<Sheet,Integer>`	`progressConsumer` A progress window
`protected boolean`	`ready`
`protected Sheet`	`sheet`
`protected boolean`	`withBom`
`protected Path`	`workSheetPath` 临时路径
`protected CSVUtil.Writer`	`writer`

构造器概要

构造器
构造器和说明

CSVWorksheetWriter()

CSVWorksheetWriter(Sheet sheet)

CSVWorksheetWriter(Sheet sheet, boolean withBom)

构造器
构造器和说明
`CSVWorksheetWriter()`
`CSVWorksheetWriter(Sheet sheet)`
`CSVWorksheetWriter(Sheet sheet, boolean withBom)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`IWorksheetWriter`	`clone()` 复制工作表输出协议
`void`	`close()`
`ICellValueAndStyle`	`getCellValueAndStyle()` 返回CSV数据样式转换器，该转换器将所有数据转为字符器格式并忽略所有样式
`int`	`getColumnLimit()` The column limit
`String`	`getFileSuffix()` Returns the worksheet name
`int`	`getRowLimit()` The row limit
`protected Path`	`initWriter(Path root)`
`CSVWorksheetWriter`	`setCharset(Charset charset)` 设置字符集
`CSVWorksheetWriter`	`setDelimiter(char delimiter)` Settings delimiter char
`IWorksheetWriter`	`setWorksheet(Sheet sheet)` 设置工作表
`protected void`	`writeBefore()` Write worksheet header data
`void`	`writeData(RowBlock rowBlock)` PUSH模式推行数据
`protected void`	`writeRow(Row row)` Write a row data
`protected void`	`writeRowBlock(RowBlock rowBlock)` Write a row-block
`protected void`	`writeRowBlockFireProgress(RowBlock rowBlock)` Write a row-block and fire progress event
`void`	`writeTo(Path root)` 写入指定路径，传入的参数可以是一个文件也可以是文件夹，需要在实现类具体处理

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.ttzero.excel.entity.IWorksheetWriter
isBigDecimal, isBool, isChar, isDate, isDateTime, isDouble, isFloat, isInt, isLocalDate, isLocalDateTime, isLocalTime, isLong, isShort, isString, isTime, writePicture, writeTo

- 字段详细资料
  - sheet
```
protected Sheet sheet
```
  - writer
```
protected CSVUtil.Writer writer
```
  - progressConsumer
```
protected BiConsumer<Sheet,Integer> progressConsumer
```
    A progress window
  - withBom
```
protected boolean withBom
```
  - ready
```
protected boolean ready
```
  - charset
```
protected Charset charset
```
  - delimiter
```
protected char delimiter
```
    Delimiter char
  - workSheetPath
```
protected Path workSheetPath
```
    临时路径
- 构造器详细资料
  - CSVWorksheetWriter
```
public CSVWorksheetWriter()
```
  - CSVWorksheetWriter
```
public CSVWorksheetWriter(Sheet sheet)
```
  - CSVWorksheetWriter
```
public CSVWorksheetWriter(Sheet sheet,
                          boolean withBom)
```
- 方法详细资料
  - getRowLimit
```
public int getRowLimit()
```
    The row limit
    
    指定者:
    
    getRowLimit 在接口中 IWorksheetWriter
    
    返回:
    
    the const value (1 << 31) - 1
  - getColumnLimit
```
public int getColumnLimit()
```
    The column limit
    
    指定者:
    
    getColumnLimit 在接口中 IWorksheetWriter
    
    返回:
    
    the const value 16_384
  - setDelimiter
```
public CSVWorksheetWriter setDelimiter(char delimiter)
```
    Settings delimiter char
    
    参数:
    
    delimiter - delimiter char
    
    返回:
    
    current CSVWorksheetWriter
  - setWorksheet
```
public IWorksheetWriter setWorksheet(Sheet sheet)
```
    从接口复制的说明: IWorksheetWriter
    
    设置工作表
    
    指定者:
    
    setWorksheet 在接口中 IWorksheetWriter
    
    参数:
    
    sheet - 工作表Sheet
    
    返回:
    
    当前输出协议
  - clone
```
public IWorksheetWriter clone()
```
    从接口复制的说明: IWorksheetWriter
    
    复制工作表输出协议
    
    指定者:
    
    clone 在接口中 IWorksheetWriter
    
    覆盖:
    
    clone 在类中 Object
    
    返回:
    
    IWorksheetWriter
  - getFileSuffix
```
public String getFileSuffix()
```
    Returns the worksheet name
    
    指定者:
    
    getFileSuffix 在接口中 IWorksheetWriter
    
    返回:
    
    name of worksheet
  - writeData
```
public void writeData(RowBlock rowBlock)
               throws IOException
```
    从接口复制的说明: IWorksheetWriter
    
    PUSH模式推行数据
    
    指定者:
    
    writeData 在接口中 IWorksheetWriter
    
    参数:
    
    rowBlock - 行块
    
    抛出:
    
    IOException - if I/O error occur
  - close
```
public void close()
           throws IOException
```
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    IOException
  - writeTo
```
public void writeTo(Path root)
             throws IOException
```
    从接口复制的说明: Storable
    
    写入指定路径，传入的参数可以是一个文件也可以是文件夹，需要在实现类具体处理
    
    指定者:
    
    writeTo 在接口中 Storable
    
    参数:
    
    root - 父级文件夹或文件绝对路径
    
    抛出:
    
    IOException - 写失败异常
  - initWriter
```
protected Path initWriter(Path root)
                   throws IOException
```
    抛出:
    
    IOException
  - writeBefore
```
protected void writeBefore()
                    throws IOException
```
    Write worksheet header data
    
    抛出:
    
    IOException - if I/O error occur
  - writeRowBlock
```
protected void writeRowBlock(RowBlock rowBlock)
                      throws IOException
```
    Write a row-block
    
    参数:
    
    rowBlock - the row-block
    
    抛出:
    
    IOException - if I/O error occur.
  - writeRowBlockFireProgress
```
protected void writeRowBlockFireProgress(RowBlock rowBlock)
                                  throws IOException
```
    Write a row-block and fire progress event
    
    参数:
    
    rowBlock - the row-block
    
    抛出:
    
    IOException - if I/O error occur.
  - writeRow
```
protected void writeRow(Row row)
                 throws IOException
```
    Write a row data
    
    参数:
    
    row - a row data
    
    抛出:
    
    IOException - if I/O error occur
  - setCharset
```
public CSVWorksheetWriter setCharset(Charset charset)
```
    设置字符集
    
    参数:
    
    charset - Charset
    
    返回:
    
    当前Writer
  - getCellValueAndStyle
```
public ICellValueAndStyle getCellValueAndStyle()
```
    返回CSV数据样式转换器，该转换器将所有数据转为字符器格式并忽略所有样式
    
    指定者:
    
    getCellValueAndStyle 在接口中 IWorksheetWriter
    
    返回:
    
    ICellValueAndStyle

类 CSVWorksheetWriter

字段概要

构造器概要

方法概要

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

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

字段详细资料

sheet

writer

progressConsumer

withBom

ready

charset

delimiter

workSheetPath

构造器详细资料

CSVWorksheetWriter

CSVWorksheetWriter

CSVWorksheetWriter

方法详细资料

getRowLimit

getColumnLimit

setDelimiter

setWorksheet

clone

getFileSuffix

writeData

close

writeTo

initWriter

writeBefore

writeRowBlock

writeRowBlockFireProgress

writeRow

setCharset

getCellValueAndStyle