StreamingReader.Builder (Streaming Excel reader 2.1.0 API)

java.lang.Object
- com.monitorjbl.xlsx.StreamingReader.Builder

Enclosing class:: StreamingReader

public static class StreamingReader.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`StreamingReader.Builder`	`bufferSize(int bufferSize)` The number of bytes to read into memory from the input resource.
`int`	`getBufferSize()`
`String`	`getPassword()`
`int`	`getRowCacheSize()`
`int`	`getSheetIndex()` Deprecated. This method will be removed in a future release.
`String`	`getSheetName()` Deprecated. This method will be removed in a future release.
`int`	`getSstCacheSize()`
`org.apache.poi.ss.usermodel.Workbook`	`open(File file)` Reads a given `File` and returns a new instance of `Workbook`.
`org.apache.poi.ss.usermodel.Workbook`	`open(InputStream is)` Reads a given `InputStream` and returns a new instance of `Workbook`.
`StreamingReader.Builder`	`password(String password)` For password protected files specify password to open file.
`StreamingReader`	`read(File f)` Deprecated. This method will be removed in a future release. Use `open(File)` instead
`StreamingReader`	`read(InputStream is)` Deprecated. This method will be removed in a future release. Use `open(InputStream)` instead
`StreamingReader.Builder`	`rowCacheSize(int rowCacheSize)` The number of rows to keep in memory at any given point.
`StreamingReader.Builder`	`sheetIndex(int sheetIndex)` Deprecated. This method will be removed in a future release. Use `StreamingWorkbook.getSheetAt(int)` instead.
`StreamingReader.Builder`	`sheetName(String sheetName)` Deprecated. This method will be removed in a future release. Use `StreamingWorkbook.getSheet(String)` instead.
`StreamingReader.Builder`	`sstCacheSize(int sstCacheSize)` !!! This option is experimental !!!

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - getRowCacheSize
```
public int getRowCacheSize()
```
  - getBufferSize
```
public int getBufferSize()
```
  - getSheetIndex
```
public int getSheetIndex()
```
    Deprecated. This method will be removed in a future release.
    
    Returns:
    
    The sheet index
  - getSheetName
```
public String getSheetName()
```
    Deprecated. This method will be removed in a future release.
    
    Returns:
    
    The sheet name
  - getPassword
```
public String getPassword()
```
    Returns:
    
    The password to use to unlock this workbook
  - getSstCacheSize
```
public int getSstCacheSize()
```
    Returns:
    
    The size of the shared string table cache. If less than 0, no cache will be used and the entire table will be loaded into memory.
  - rowCacheSize
```
public StreamingReader.Builder rowCacheSize(int rowCacheSize)
```
    The number of rows to keep in memory at any given point.
    Defaults to 10
    
    Parameters:
    
    rowCacheSize - number of rows
    
    Returns:
    
    reference to current Builder
  - bufferSize
```
public StreamingReader.Builder bufferSize(int bufferSize)
```
    The number of bytes to read into memory from the input resource.
    Defaults to 1024
    
    Parameters:
    
    bufferSize - buffer size in bytes
    
    Returns:
    
    reference to current Builder
  - sheetIndex
```
public StreamingReader.Builder sheetIndex(int sheetIndex)
```
    Deprecated. This method will be removed in a future release. Use StreamingWorkbook.getSheetAt(int) instead.
    
    Which sheet to open. There can only be one sheet open for a single instance of StreamingReader. If more sheets need to be read, a new instance must be created.
    Defaults to 0
    
    Parameters:
    
    sheetIndex - index of sheet
    
    Returns:
    
    reference to current Builder
  - sheetName
```
public StreamingReader.Builder sheetName(String sheetName)
```
    Deprecated. This method will be removed in a future release. Use StreamingWorkbook.getSheet(String) instead.
    
    Which sheet to open. There can only be one sheet open for a single instance of StreamingReader. If more sheets need to be read, a new instance must be created.
    
    Parameters:
    
    sheetName - name of sheet
    
    Returns:
    
    reference to current Builder
  - password
```
public StreamingReader.Builder password(String password)
```
    For password protected files specify password to open file. If the password is incorrect a ReadException is thrown on read.
    NULL indicates that no password should be used, this is the default value.
    
    Parameters:
    
    password - to use when opening file
    
    Returns:
    
    reference to current Builder
  - sstCacheSize
```
public StreamingReader.Builder sstCacheSize(int sstCacheSize)
```
    !!! This option is experimental !!!
    Set the size of the Shared Strings Table cache. This option exists to accommodate extremely large workbooks with millions of unique strings. Normally the SST is entirely loaded into memory, but with large workbooks with high cardinality (i.e., very few duplicate values) the SST may not fit entirely into memory.
    By default, the entire SST *will* be loaded into memory. Setting a value greater than 0 for this option will only cache up to this many entries in memory. However, enabling this option at all will have some noticeable performance degredation as you are trading memory for disk space.
    
    Parameters:
    
    sstCacheSize - size of SST cache
    
    Returns:
    
    reference to current Builder
  - open
```
public org.apache.poi.ss.usermodel.Workbook open(InputStream is)
```
    Reads a given InputStream and returns a new instance of Workbook. Due to Apache POI limitations, a temporary file must be written in order to create a streaming iterator. This process will use the same buffer size as specified in bufferSize(int).
    
    Parameters:
    
    is - input stream to read in
    
    Returns:
    
    A Workbook that can be read from
    
    Throws:
    
    ReadException - if there is an issue reading the stream
  - open
```
public org.apache.poi.ss.usermodel.Workbook open(File file)
```
    Reads a given File and returns a new instance of Workbook.
    
    Parameters:
    
    file - file to read in
    
    Returns:
    
    built streaming reader instance
    
    Throws:
    
    OpenException - if there is an issue opening the file
    
    ReadException - if there is an issue reading the file
  - read
```
public StreamingReader read(InputStream is)
```
    Deprecated. This method will be removed in a future release. Use open(InputStream) instead
    
    Reads a given InputStream and returns a new instance of StreamingReader. Due to Apache POI limitations, a temporary file must be written in order to create a streaming iterator. This process will use the same buffer size as specified in bufferSize(int).
    
    Parameters:
    
    is - input stream to read in
    
    Returns:
    
    built streaming reader instance
    
    Throws:
    
    ReadException - if there is an issue reading the stream
  - read
```
public StreamingReader read(File f)
```
    Deprecated. This method will be removed in a future release. Use open(File) instead
    
    Reads a given File and returns a new instance of StreamingReader.
    
    Parameters:
    
    f - file to read in
    
    Returns:
    
    built streaming reader instance
    
    Throws:
    
    OpenException - if there is an issue opening the file
    
    ReadException - if there is an issue reading the file

Class StreamingReader.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

getRowCacheSize

getBufferSize

getSheetIndex

getSheetName

getPassword

getSstCacheSize

rowCacheSize

bufferSize

sheetIndex

sheetName

password

sstCacheSize

!!! This option is experimental !!!

open

open

read

read