SharedStringTable (Excel Write/Read Framework 0.5.4 API)

java.lang.Object
- org.ttzero.excel.entity.SharedStringTable

所有已实现的接口:

Closeable, AutoCloseable, Iterable<String>

直接已知子类:

IndexSharedStringTable
```
public class SharedStringTable
extends Object
implements Closeable, Iterable<String>
```
作者:

guanquan.wang at 2019-05-10 20:04

字段概要

字段
限定符和类型字段和说明

protected int defaultBufferSize
Buffer size(4K)

protected boolean shouldDelete
Delete the temp file if @author SharedStringTable

字段
限定符和类型	字段和说明
`protected int`	`defaultBufferSize` Buffer size(4K)
`protected boolean`	`shouldDelete` Delete the temp file if @author `SharedStringTable`

构造器概要

构造器
限定符	构造器和说明
`protected`	`SharedStringTable()` Create a temp file to storage shared strings
`protected`	`SharedStringTable(Path path)` Constructor a SharedStringTable with a exists file

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`protected boolean`	`checkCapacityAndGrow()` Check remaining data and grow if shortage
`void`	`close()` Close channel and delete temp files
`protected void`	`commit()` Commit current index file writer
`int`	`find(char c)` Find character value from begging
`int`	`find(char c, long pos)` Find from the specified location
`int`	`find(String key)` Find value from begging
`int`	`find(String key, long pos)` Find from the specified location
`protected Path`	`getTemp()`
`static ByteBuffer`	`grow(ByteBuffer buffer)` Grow a new Buffer
`static int`	`hasFullValue(ByteBuffer buffer)` Check the remaining data is complete
`Iterator<String>`	`iterator()` Returns an iterator over elements of type String
`protected SharedStringTable`	`mark()` Sets this buffer's mark at its position.
`protected long`	`position()` Returns this buffer's position.
`int`	`push(char c)` Write character value into table
`int`	`push(String key)` Write string value into table
`protected int`	`read(ByteBuffer buffer)` Returns a ByteBuffer data from channel position
`protected SharedStringTable`	`reset()` Resets this buffer's position to the previously-marked position.
`int`	`size()` Returns the cache size
`protected SharedStringTable`	`skip(long position)` Jump to the specified position, the actual moving position will be increased by 4, the header contains an integer value.

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

从接口继承的方法 java.lang.Iterable
forEach, spliterator

- 字段详细资料
  - shouldDelete
```
protected boolean shouldDelete
```
    Delete the temp file if @author SharedStringTable
  - defaultBufferSize
```
protected int defaultBufferSize
```
    Buffer size(4K)
- 构造器详细资料
  - SharedStringTable
```
protected SharedStringTable()
                     throws IOException
```
    Create a temp file to storage shared strings
    
    抛出:
    
    IOException - if I/O error occur.
  - SharedStringTable
```
protected SharedStringTable(Path path)
                     throws IOException
```
    Constructor a SharedStringTable with a exists file
    
    参数:
    
    path - the file path
    
    抛出:
    
    IOException - if file not exists or I/O error occur.
- 方法详细资料
  - getTemp
```
protected Path getTemp()
```
  - push
```
public int push(char c)
         throws IOException
```
    Write character value into table
    
    参数:
    
    c - the character value
    
    返回:
    
    the value index of table
    
    抛出:
    
    IOException - if io error occur
  - push
```
public int push(String key)
         throws IOException
```
    Write string value into table
    
    参数:
    
    key - the string value
    
    返回:
    
    the value index of table
    
    抛出:
    
    IOException - if io error occur
  - find
```
public int find(char c)
         throws IOException
```
    Find character value from begging
    
    参数:
    
    c - the character to find
    
    返回:
    
    the index of character in shared string table
    
    抛出:
    
    IOException - if io error occur
  - find
```
public int find(char c,
                long pos)
         throws IOException
```
    Find from the specified location
    
    参数:
    
    c - the character to find
    
    pos - the buffer's position
    
    返回:
    
    the index of character in shared string table
    
    抛出:
    
    IOException - if io error occur
  - find
```
public int find(String key)
         throws IOException
```
    Find value from begging
    
    参数:
    
    key - the key to find
    
    返回:
    
    the index of character in shared string table
    
    抛出:
    
    IOException - if io error occur
  - find
```
public int find(String key,
                long pos)
         throws IOException
```
    Find from the specified location
    
    参数:
    
    key - the key to find
    
    pos - the buffer's position
    
    返回:
    
    the index of character in shared string table
    
    抛出:
    
    IOException - if io error occur
  - size
```
public int size()
```
    Returns the cache size
    
    返回:
    
    total keyword
  - checkCapacityAndGrow
```
protected boolean checkCapacityAndGrow()
```
    Check remaining data and grow if shortage
    
    返回:
    
    true/false
  - grow
```
public static ByteBuffer grow(ByteBuffer buffer)
```
    Grow a new Buffer
    
    参数:
    
    buffer - Old buffer
    
    返回:
    
    new capacity buffer at WRITE STATUS
  - hasFullValue
```
public static int hasFullValue(ByteBuffer buffer)
```
    Check the remaining data is complete
    
    参数:
    
    buffer - the ByteBuffer
    
    返回:
    
    1: full 0: shortage -1: The length of the word exceeds the Buffer
  - commit
```
protected void commit()
               throws IOException
```
    Commit current index file writer
    
    抛出:
    
    IOException - if I/O error occur
  - close
```
public void close()
           throws IOException
```
    Close channel and delete temp files
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    IOException - if I/O error occur
  - position
```
protected long position()
                 throws IOException
```
    Returns this buffer's position.
    
    返回:
    
    The position of this buffer
    
    抛出:
    
    IOException - if I/O error occur
  - read
```
protected int read(ByteBuffer buffer)
            throws IOException
```
    Returns a ByteBuffer data from channel position
    
    参数:
    
    buffer - the byte buffer
    
    返回:
    
    the read data length
    
    抛出:
    
    IOException - if I/O error occur
  - mark
```
protected SharedStringTable mark()
                          throws IOException
```
    Sets this buffer's mark at its position.
    
    返回:
    
    This SharedStringTable
    
    抛出:
    
    IOException - if I/O error occur
  - reset
```
protected SharedStringTable reset()
                           throws IOException
```
    Resets this buffer's position to the previously-marked position. Invoking this method neither changes nor discards the mark's value.
    
    返回:
    
    This SharedStringTable
    
    抛出:
    
    InvalidMarkException - If the mark has not been set
    
    IOException - if I/O error occur
  - skip
```
protected SharedStringTable skip(long position)
                          throws IOException
```
    Jump to the specified position, the actual moving position will be increased by 4, the header contains an integer value.
    
    参数:
    
    position - the position to jump
    
    返回:
    
    the SharedStringTable
    
    抛出:
    
    IOException - if I/O error occur
  - iterator
```
public Iterator<String> iterator()
```
    Returns an iterator over elements of type String
    
    指定者:
    
    iterator 在接口中 Iterable<String>
    
    返回:
    
    an Iterator.

类 SharedStringTable

字段概要

构造器概要

方法概要

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

从接口继承的方法 java.lang.Iterable

字段详细资料

shouldDelete

defaultBufferSize

构造器详细资料

SharedStringTable

SharedStringTable

方法详细资料

getTemp

push

push

find

find

find

find

size

checkCapacityAndGrow

grow

hasFullValue

commit

close

position

read

mark

reset

skip

iterator