Package com.github.pjfanning.xlsx.impl

Class StreamingWorkbookReader

java.lang.Object

com.github.pjfanning.xlsx.impl.StreamingWorkbookReader

All Implemented Interfaces:

AutoCloseable, Iterable<org.apache.poi.ss.usermodel.Sheet>

public class StreamingWorkbookReader
extends Object
implements Iterable<org.apache.poi.ss.usermodel.Sheet>, AutoCloseable

Constructor Summary

Constructors

Constructor	Description
StreamingWorkbookReader(StreamingReader.Builder builder)
StreamingWorkbookReader(org.apache.poi.xssf.model.SharedStringsTable sst, org.apache.poi.openxml4j.opc.OPCPackage pkg, StreamingSheetReader reader, StreamingReader.Builder builder)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	close()
StreamingSheetReader	first()
List<Map<String,String>>	getSheetProperties()
void	init(File f)
void	init(InputStream is)
Iterator<org.apache.poi.ss.usermodel.Sheet>	iterator()

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, spliterator

Constructor Detail

StreamingWorkbookReader

@Deprecated
public StreamingWorkbookReader(org.apache.poi.xssf.model.SharedStringsTable sst,
                               org.apache.poi.openxml4j.opc.OPCPackage pkg,
                               StreamingSheetReader reader,
                               StreamingReader.Builder builder)

Deprecated.

This constructor exists only so the StreamingReader can instantiate a StreamingWorkbook using its own reader implementation. Do not use going forward.

Parameters:

sst - The SST data for this workbook

pkg - The POI package that should be closed when this workbook is closed

reader - A single streaming reader instance

builder - The builder containing all options

StreamingWorkbookReader

public StreamingWorkbookReader(StreamingReader.Builder builder)

Method Detail

first

public StreamingSheetReader first()

init

public void init(InputStream is)

init

public void init(File f)

getSheetProperties

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

iterator

public Iterator<org.apache.poi.ss.usermodel.Sheet> iterator()

Specified by:

iterator in interface Iterable<org.apache.poi.ss.usermodel.Sheet>

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException