StreamingReader.Builder (excel-streaming-reader 3.5.0 API)

java.lang.Object
- com.github.pjfanning.xlsx.StreamingReader.Builder

Enclosing class:: StreamingReader

public static class StreamingReader.Builder
extends java.lang.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
`boolean`	`adjustLegacyComments()`
`boolean`	`avoidTempFiles()`
`StreamingReader.Builder`	`bufferSize(int bufferSize)` The number of bytes to read into memory from the input resource.
`boolean`	`encryptCommentsTempFile()`
`boolean`	`encryptSstTempFile()`
`boolean`	`fullFormatRichText()` Whether to parse the full formatting data for rich text shared strings and comments.
`int`	`getBufferSize()`
`CommentsImplementationType`	`getCommentsImplementationType()`
`java.lang.String`	`getPassword()`
`int`	`getRowCacheSize()`
`SharedStringsImplementationType`	`getSharedStringsImplementationType()`
`org.apache.poi.ss.usermodel.Workbook`	`open(java.io.File file)` Reads a given `File` and returns a new instance of `Workbook`.
`org.apache.poi.ss.usermodel.Workbook`	`open(java.io.InputStream is)` Reads a given `InputStream` and returns a new instance of `Workbook`.
`StreamingReader.Builder`	`password(java.lang.String password)` For password protected files, specify password to open file.
`boolean`	`readComments()`
`boolean`	`readCoreProperties()`
`boolean`	`readHyperlinks()`
`boolean`	`readShapes()`
`boolean`	`readSharedFormulas()`
`boolean`	`readStyles()`
`StreamingReader.Builder`	`rowCacheSize(int rowCacheSize)` The number of rows to keep in memory at any given point.
`StreamingReader.Builder`	`setAdjustLegacyComments(boolean adjustLegacyComments)` Enables adjustments to comments to remove boiler-plate text (related to threaded comments).
`StreamingReader.Builder`	`setAvoidTempFiles(boolean avoidTempFiles)` Enables a mode where the code tries to avoid creating temp files.
`StreamingReader.Builder`	`setCommentsImplementationType(CommentsImplementationType commentsImplementationType)` Set the type of Comments Table to use.
`StreamingReader.Builder`	`setEncryptCommentsTempFile(boolean encryptCommentsTempFile)` Enables use of encryption in the Comments temp file.
`StreamingReader.Builder`	`setEncryptSstTempFile(boolean encryptSstTempFile)` Enables use of encryption in Shared Strings Table temp file.
`StreamingReader.Builder`	`setFullFormatRichText(boolean fullFormatRichText)` Whether to parse the full formatting data for rich text shared strings and comments.
`StreamingReader.Builder`	`setReadComments(boolean readComments)` Enables the reading of the comments.
`StreamingReader.Builder`	`setReadCoreProperties(boolean readCoreProperties)` Enables the reading of the core document properties.
`StreamingReader.Builder`	`setReadHyperlinks(boolean readHyperlinks)` Enables the reading of hyperlink data associated with sheets).
`StreamingReader.Builder`	`setReadShapes(boolean readShapes)` Enables the reading of shape data.
`StreamingReader.Builder`	`setReadSharedFormulas(boolean readSharedFormulas)` Enables the reading of shared formulas.
`StreamingReader.Builder`	`setReadStyles(boolean readStyles)` Enables/disables the reading of styles data.
`StreamingReader.Builder`	`setSharedStringsImplementationType(SharedStringsImplementationType sharedStringsImplementationType)` Set the type of Shared Strings Table to use.
`StreamingReader.Builder`	`setUseCommentsTempFile(boolean useCommentsTempFile)` Deprecated. use `setCommentsImplementationType(CommentsImplementationType)`
`StreamingReader.Builder`	`setUseSstReadOnly(boolean useSstReadOnly)` Deprecated. use `setSharedStringsImplementationType(SharedStringsImplementationType)`
`StreamingReader.Builder`	`setUseSstTempFile(boolean useSstTempFile)` Deprecated. use `setSharedStringsImplementationType(SharedStringsImplementationType)`
`boolean`	`useCommentsTempFile()` Deprecated. use `getCommentsImplementationType()`
`boolean`	`useSstReadOnly()` Deprecated. use #getSharedStringsImplementationType()
`boolean`	`useSstTempFile()` Deprecated. use #getSharedStringsImplementationType()

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()
```
  - getPassword
```
public java.lang.String getPassword()
```
    Returns:
    
    The password to use to unlock this workbook
  - avoidTempFiles
```
public boolean avoidTempFiles()
```
    Returns:
    
    Whether to avoid temp files when reading input streams.
  - getSharedStringsImplementationType
```
public SharedStringsImplementationType getSharedStringsImplementationType()
```
    Returns:
    
    the type of shared string table implementation (default is POI_READ_ONLY).
    
    Since:
    
    v3.5.0
    
    See Also:
    
    setSharedStringsImplementationType(SharedStringsImplementationType)
  - getCommentsImplementationType
```
public CommentsImplementationType getCommentsImplementationType()
```
    Returns:
    
    the type of comments table implementation (default is POI_DEFAULT).
    
    Since:
    
    v3.5.0
    
    See Also:
    
    setCommentsImplementationType(CommentsImplementationType)
  - useSstTempFile
```
@Deprecated
public boolean useSstTempFile()
```
    Deprecated. use #getSharedStringsImplementationType()
    
    Returns:
    
    Whether to use a temp file for the Shared Strings data. If false, no temp file will be used and the entire table will be loaded into memory.
  - useSstReadOnly
```
@Deprecated
public boolean useSstReadOnly()
```
    Deprecated. use #getSharedStringsImplementationType()
    
    Returns:
    
    Whether to use ReadOnlySharedStringsTable instead of SharedStringsTable. If you use setUseSstTempFile(boolean) and set to `true`, then this setting is ignored.
    
    Since:
    
    v3.3.0
    
    See Also:
    
    useSstTempFile()
  - encryptSstTempFile
```
public boolean encryptSstTempFile()
```
    Returns:
    
    Whether to encrypt the temp file for the Shared Strings data. Only applies if useSstTempFile() is true.
  - adjustLegacyComments
```
public boolean adjustLegacyComments()
```
    Returns:
    
    Whether to adjust comments to remove boilerplate text (related to threaded comments). See https://github.com/pjfanning/excel-streaming-reader/issues/57
  - readComments
```
public boolean readComments()
```
    Returns:
    
    Whether to read the comments associated with sheets and cells.
  - useCommentsTempFile
```
@Deprecated
public boolean useCommentsTempFile()
```
    Deprecated. use getCommentsImplementationType()
    
    Returns:
    
    Whether to use a temp file for the Comments data. If false, no temp file will be used and the entire table will be loaded into memory.
  - encryptCommentsTempFile
```
public boolean encryptCommentsTempFile()
```
    Returns:
    
    Whether to encrypt the temp file for the Comments data. Only applies if useCommentsTempFile() is true.
  - readCoreProperties
```
public boolean readCoreProperties()
```
    Returns:
    
    Whether to read the core document properties.
  - readHyperlinks
```
public boolean readHyperlinks()
```
    Returns:
    
    Whether to read the hyperlink data that appear in sheets.
  - readShapes
```
public boolean readShapes()
```
    Returns:
    
    Whether to read the shapes (associated with pictures that appear in sheets).
  - readSharedFormulas
```
public boolean readSharedFormulas()
```
    Returns:
    
    Whether to read the shared formulas. Only affects cell formulas, cell values are retrieved using values stored in the sheet data.
  - readStyles
```
public boolean readStyles()
```
    Returns:
    
    Whether to read the styles (associated with cells). Defaults to true.
    
    Since:
    
    v3.3.0
  - fullFormatRichText
```
public boolean fullFormatRichText()
```
    Whether to parse the full formatting data for rich text shared strings and comments. This only has an effect if temp file SST and/or Comments Table support is enabled. The default is false. When you don't use temp file support, full formatting data is returned for the rich text anyway.
    
    Returns:
    
    Whether to parse the full formatting data for rich text shared strings and comments.
    
    See Also:
    
    useSstTempFile(), useCommentsTempFile()
  - 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
  - password
```
public StreamingReader.Builder password(java.lang.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
  - setAvoidTempFiles
```
public StreamingReader.Builder setAvoidTempFiles(boolean avoidTempFiles)
```
    Enables a mode where the code tries to avoid creating temp files. This is independent of #setUseSstTempFile and #setUseCommentsTempFile.
    By default, temp files are used to avoid holding onto too much data in memory.
    
    Parameters:
    
    avoidTempFiles - whether to avoid using temp files when reading from input streams
    
    Returns:
    
    reference to current Builder
  - setSharedStringsImplementationType
```
public StreamingReader.Builder setSharedStringsImplementationType(SharedStringsImplementationType sharedStringsImplementationType)
```
    Set the type of Shared Strings Table to use. The default is POI_READ_ONLY.
    If you enable this feature, you may also want to enable fullFormatRichText.
    
    Parameters:
    
    sharedStringsImplementationType - type of Shared Strings Table to use (must not be null)
    
    Returns:
    
    reference to current Builder
    
    Throws:
    
    java.lang.NullPointerException - if null is passed as a param
    
    Since:
    
    v3.5.0
    
    See Also:
    
    getSharedStringsImplementationType()
  - setCommentsImplementationType
```
public StreamingReader.Builder setCommentsImplementationType(CommentsImplementationType commentsImplementationType)
```
    Set the type of Comments Table to use. The default is POI_DEFAULT.
    If you enable this feature, you may also want to enable fullFormatRichText.
    
    Parameters:
    
    commentsImplementationType - type of Comments Table to use (must not be null)
    
    Returns:
    
    reference to current Builder
    
    Throws:
    
    java.lang.NullPointerException - if null is passed as a param
    
    Since:
    
    v3.5.0
    
    See Also:
    
    getCommentsImplementationType()
  - setUseSstTempFile
```
@Deprecated
public StreamingReader.Builder setUseSstTempFile(boolean useSstTempFile)
```
    Deprecated. use setSharedStringsImplementationType(SharedStringsImplementationType)
    
    Enables use of Shared Strings Table temp file. 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. However, enabling this option at all will have some noticeable performance degradation as you are trading memory for disk space.
    If you enable this feature, you may also want to enable fullFormatRichText.
    
    Parameters:
    
    useSstTempFile - whether to use a temp file to store the Shared Strings Table data
    
    Returns:
    
    reference to current Builder
    
    See Also:
    
    setEncryptSstTempFile(boolean), setFullFormatRichText(boolean), setUseSstReadOnly(boolean)
  - setUseSstReadOnly
```
@Deprecated
public StreamingReader.Builder setUseSstReadOnly(boolean useSstReadOnly)
```
    Deprecated. use setSharedStringsImplementationType(SharedStringsImplementationType)
    
    If you use an in memory Shared String Table (default), this controls which in memory implementation to use. ReadOnlySharedStringsTable is a simpler implementation than the default SharedStringsTable and uses less memory - but may not support formatted text as well.
    
    Parameters:
    
    useSstReadOnly - Whether to use ReadOnlySharedStringsTable instead of SharedStringsTable.
    
    Returns:
    
    reference to current Builder
    
    Since:
    
    v3.3.0
    
    See Also:
    
    setUseSstTempFile(boolean)
  - setEncryptSstTempFile
```
public StreamingReader.Builder setEncryptSstTempFile(boolean encryptSstTempFile)
```
    Enables use of encryption in Shared Strings Table temp file. This only applies if setUseSstTempFile is set to true.
    By default, the temp file is not encrypted. However, enabling this option could slow down the processing of Shared Strings data.
    
    Parameters:
    
    encryptSstTempFile - whether to encrypt the temp file used to store the Shared Strings Table data
    
    Returns:
    
    reference to current Builder
    
    See Also:
    
    setUseSstTempFile(boolean)
  - setUseCommentsTempFile
```
@Deprecated
public StreamingReader.Builder setUseCommentsTempFile(boolean useCommentsTempFile)
```
    Deprecated. use setCommentsImplementationType(CommentsImplementationType)
    
    Enables use of Comments temp file. This option exists to accommodate workbooks with lots of comments. Normally, the Comments are all loaded into memory.
    By default, all the Comments data *will* be loaded into memory. However, enabling this option at all will have some noticeable performance degradation as you are trading memory for disk space.
    If you enable this feature, you also want to enable fullFormatRichText.
    
    Parameters:
    
    useCommentsTempFile - whether to use a temp file to store the Comments data
    
    Returns:
    
    reference to current Builder
    
    See Also:
    
    setReadComments(boolean), setEncryptCommentsTempFile(boolean), setFullFormatRichText(boolean)
  - setEncryptCommentsTempFile
```
public StreamingReader.Builder setEncryptCommentsTempFile(boolean encryptCommentsTempFile)
```
    Enables use of encryption in the Comments temp file. This only applies if setUseCommentsTempFile is set to true.
    By default, the temp file is not encrypted. However, enabling this option could slow down the processing of Comments data.
    
    Parameters:
    
    encryptCommentsTempFile - whether to encrypt the temp file used to store the Comments data
    
    Returns:
    
    reference to current Builder
    
    See Also:
    
    setReadComments(boolean), setUseCommentsTempFile(boolean)
  - setReadComments
```
public StreamingReader.Builder setReadComments(boolean readComments)
```
    Enables the reading of the comments.
    
    Parameters:
    
    readComments - whether to read the comments associated with sheets and cells
    
    Returns:
    
    reference to current Builder
  - setAdjustLegacyComments
```
public StreamingReader.Builder setAdjustLegacyComments(boolean adjustLegacyComments)
```
    Enables adjustments to comments to remove boiler-plate text (related to threaded comments). See https://github.com/pjfanning/excel-streaming-reader/issues/57.
    
    Parameters:
    
    adjustLegacyComments - whether to adjust legacy comments to remove boilerplate comments
    
    Returns:
    
    reference to current Builder
  - setReadCoreProperties
```
public StreamingReader.Builder setReadCoreProperties(boolean readCoreProperties)
```
    Enables the reading of the core document properties.
    
    Parameters:
    
    readCoreProperties - whether to read the core document properties
    
    Returns:
    
    reference to current Builder
  - setReadHyperlinks
```
public StreamingReader.Builder setReadHyperlinks(boolean readHyperlinks)
```
    Enables the reading of hyperlink data associated with sheets).
    
    Parameters:
    
    readHyperlinks - whether to read hyperlink data (associated with sheets)
    
    Returns:
    
    reference to current Builder
  - setReadShapes
```
public StreamingReader.Builder setReadShapes(boolean readShapes)
```
    Enables the reading of shape data.
    
    Parameters:
    
    readShapes - whether to read shapes (associated with pictures that appear in sheets)
    
    Returns:
    
    reference to current Builder
  - setReadSharedFormulas
```
public StreamingReader.Builder setReadSharedFormulas(boolean readSharedFormulas)
```
    Enables the reading of shared formulas. This is disabled by default. This feature is experimental. Only affects cell formulas, cell values are retrieved using values stored in the sheet data.
    
    Parameters:
    
    readSharedFormulas - whether to read shared formulas
    
    Returns:
    
    reference to current Builder
  - setReadStyles
```
public StreamingReader.Builder setReadStyles(boolean readStyles)
```
    Enables/disables the reading of styles data. Enabled, by default. It is recommended that you only disable this if you need to absolutely maximise performance.
    The style data is very useful for formatting numbers in particular because the raw numbers in the Excel file are in double precision format and may not match exactly what you see in the Excel cell.
    
    With date and timestamp data, the raw data is also numeric and without the style data, the reader will treat the data as numeric. If you already know if certain cells hold date or timestamp data, the the getLocalDateTimeCellValue and getDateCellValue methods will work even if you have disabled the reading of style data.
    
    Parameters:
    
    readStyles - Whether to read the styles (associated with cells)
    
    Returns:
    
    reference to current Builder
    
    Since:
    
    v3.3.0
  - setFullFormatRichText
```
public StreamingReader.Builder setFullFormatRichText(boolean fullFormatRichText)
```
    Whether to parse the full formatting data for rich text shared strings and comments. This only has an effect if temp file SST and/or Comments Table support is enabled. The default is false. When you don't use temp file support, full formatting data is returned for the rich text anyway.
    
    Parameters:
    
    fullFormatRichText - Whether to parse the full formatting data for rich text shared strings and comments.
    
    Returns:
    
    reference to current Builder
    
    See Also:
    
    setUseSstTempFile(boolean), setUseCommentsTempFile(boolean)
  - open
```
public org.apache.poi.ss.usermodel.Workbook open(java.io.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(java.io.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

Class StreamingReader.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

getRowCacheSize

getBufferSize

getPassword

avoidTempFiles

getSharedStringsImplementationType

getCommentsImplementationType

useSstTempFile

useSstReadOnly

encryptSstTempFile

adjustLegacyComments

readComments

useCommentsTempFile

encryptCommentsTempFile

readCoreProperties

readHyperlinks

readShapes

readSharedFormulas

readStyles

fullFormatRichText

rowCacheSize

bufferSize

password

setAvoidTempFiles

setSharedStringsImplementationType

setCommentsImplementationType

setUseSstTempFile

setUseSstReadOnly

setEncryptSstTempFile

setUseCommentsTempFile

setEncryptCommentsTempFile

setReadComments

setAdjustLegacyComments

setReadCoreProperties

setReadHyperlinks

setReadShapes

setReadSharedFormulas

setReadStyles

setFullFormatRichText

open

open