br.com.beardsoft.xlsx

Class StreamingReader.Builder

java.lang.Object

br.com.beardsoft.xlsx.StreamingReader.Builder

Enclosing class:

StreamingReader

public static class StreamingReader.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
StreamingReader.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
StreamingReader.Builder	bufferSize(int bufferSize) The number of bytes to read into memory from the input resource.
StreamingReader	read(File f) Reads a given File and returns a new instance of StreamingReader.
StreamingReader	read(InputStream is) Reads a given InputStream and returns a new instance of StreamingReader.
StreamingReader.Builder	rowCacheSize(int rowCacheSize) The number of rows to keep in memory at any given point.
StreamingReader.Builder	sheetIndex(int sheetIndex) Which sheet to open.
StreamingReader.Builder	sheetName(String sheetName) Which sheet to open.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamingReader.Builder

public StreamingReader.Builder()

Method Detail

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)

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)

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

read

public StreamingReader read(InputStream is)

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:

com.monitorjbl.xlsx.exceptions.ReadException - if there is an issue reading the stream

read

public StreamingReader read(File f)

Reads a given File and returns a new instance of StreamingReader.

Parameters:

f - file to read in

Returns:

built streaming reader instance

Throws:

com.monitorjbl.xlsx.exceptions.OpenException - if there is an issue opening the file

com.monitorjbl.xlsx.exceptions.ReadException - if there is an issue reading the file