com.github.pjfanning.xlsx.impl

Class StreamingWorkbookReader

java.lang.Object

com.github.pjfanning.xlsx.impl.StreamingWorkbookReader

All Implemented Interfaces:

AutoCloseable, Iterable<Sheet>, Date1904Support

public class StreamingWorkbookReader
extends Object
implements Iterable<Sheet>, Date1904Support, AutoCloseable

Constructor Summary

Constructors

Constructor and Description
StreamingWorkbookReader(StreamingReader.Builder builder)

Method Summary

Modifier and Type	Method and Description
void	close()
StreamingSheet	getSheet(String name) Returns the sheet with the given name.
StreamingSheet	getSheetAt(int idx) Returns the sheet at the given index (0 based).
List<Map<String,String>>	getSheetProperties()
void	init(File f) Initializes the reader with the given input stream.
void	init(InputStream is) Initializes the reader with the given input stream.
boolean	isDate1904()
Iterator<Sheet>	iterator()
Spliterator<Sheet>	spliterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

StreamingWorkbookReader

public StreamingWorkbookReader(StreamingReader.Builder builder)

Method Detail

init

public void init(InputStream is)
          throws OpenException,
                 ReadException,
                 ParseException

Initializes the reader with the given input stream.

Parameters:

is - the input stream to read from

Throws:

OpenException - if an error occurs while opening the file

ReadException - if an error occurs while reading the file

ParseException - if an error occurs while parsing the file

init

public void init(File f)
          throws OpenException,
                 ReadException,
                 ParseException

Initializes the reader with the given input stream.

Parameters:

f - the file to read from

Throws:

OpenException - if an error occurs while opening the file

ReadException - if an error occurs while reading the file

ParseException - if an error occurs while parsing the file

getSheetAt

public StreamingSheet getSheetAt(int idx)
                          throws MissingSheetException,
                                 IOException,
                                 XMLStreamException

Returns the sheet at the given index (0 based).

Parameters:

idx - index (0 based)

Returns:

the sheet at the given index

Throws:

MissingSheetException - if a sheet at the given index does not exist

IOException - should never be thrown

XMLStreamException - should never be thrown

getSheet

public StreamingSheet getSheet(String name)
                        throws MissingSheetException,
                               IOException,
                               XMLStreamException

Returns the sheet with the given name.

Parameters:

name - the name of the sheet to return

Returns:

the sheet with the given name

Throws:

MissingSheetException - if a sheet with the given name does not exist

IOException - should never be thrown

XMLStreamException - should never be thrown

getSheetProperties

public List<Map<String,String>> getSheetProperties()

iterator

public Iterator<Sheet> iterator()
                         throws ReadException

Specified by:

iterator in interface Iterable<Sheet>

Throws:

ReadException

spliterator

public Spliterator<Sheet> spliterator()
                               throws ReadException

Specified by:

spliterator in interface Iterable<Sheet>

Throws:

ReadException

isDate1904

public boolean isDate1904()

Specified by:

isDate1904 in interface Date1904Support

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException