org.apache.poi.xssf.streaming

Class StreamingSheetWriter

java.lang.Object

org.apache.poi.xssf.streaming.SheetDataWriter

org.apache.poi.xssf.streaming.StreamingSheetWriter

All Implemented Interfaces:

Closeable, AutoCloseable

@Beta
public class StreamingSheetWriter
extends SheetDataWriter

Unlike SheetDataWriter, this writer does not create a temporary file, it writes data directly to the provided OutputStream.

Since:

5.0.0

Field Summary

Fields inherited from class org.apache.poi.xssf.streaming.SheetDataWriter

_out

Constructor Summary

Constructors

Constructor and Description
StreamingSheetWriter() Deprecated. use StreamingSheetWriter(OutputStream)
StreamingSheetWriter(OutputStream out)

Method Summary

Modifier and Type	Method and Description
void	close() flush and close the temp data writer.
File	createTempFile() Create a temp file to write sheet data.
Writer	createWriter(File fd) Create a writer for the sheet data.
protected static Writer	createWriter(OutputStream out) Create a writer for the sheet data.
InputStream	getWorksheetXMLInputStream()

Methods inherited from class org.apache.poi.xssf.streaming.SheetDataWriter

decorateInputStream, decorateOutputStream, getLastFlushedRow, getLowestIndexOfFlushedRows, getNumberOfCellsOfLastFlushedRow, getNumberOfFlushedRows, getTempFile, outputEscapedString, writeCell, writeRow

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamingSheetWriter

@Removal(version="6.0.0")
public StreamingSheetWriter()
                                               throws IOException

Deprecated. use StreamingSheetWriter(OutputStream)

Throws:

IOException - always thrown, use the constructor with an OutputStream

StreamingSheetWriter

public StreamingSheetWriter(OutputStream out)
                     throws IOException

Throws:

IOException

Method Detail

createTempFile

public File createTempFile()
                    throws IOException

Description copied from class: SheetDataWriter

Create a temp file to write sheet data. By default, temp files are created in the default temporary-file directory with a prefix "poi-sxssf-sheet" and suffix ".xml". Subclasses can override it and specify a different temp directory or filename or suffix, e.g. .gz

Overrides:

createTempFile in class SheetDataWriter

Returns:

temp file to write sheet data

Throws:

IllegalStateException - always thrown - not supported

IOException

createWriter

public Writer createWriter(File fd)
                    throws IOException

Description copied from class: SheetDataWriter

Create a writer for the sheet data.

Overrides:

createWriter in class SheetDataWriter

Parameters:

fd - the file to write to

Throws:

IllegalStateException - always thrown - not supported

IOException

createWriter

protected static Writer createWriter(OutputStream out)
                              throws IOException

Create a writer for the sheet data.

Parameters:

out - the output stream to write to

Throws:

IOException

close

public void close()
           throws IOException

Description copied from class: SheetDataWriter

flush and close the temp data writer. This method must be invoked before calling SheetDataWriter.getWorksheetXMLInputStream()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class SheetDataWriter

Throws:

IOException

getWorksheetXMLInputStream

public InputStream getWorksheetXMLInputStream()
                                       throws IOException

Overrides:

getWorksheetXMLInputStream in class SheetDataWriter

Returns:

a stream to read temp file with the sheet data

Throws:

IllegalStateException - always thrown - not supported

IOException