Package org.apache.poi.poifs.filesystem
Class POIFSStream
java.lang.Object
org.apache.poi.poifs.filesystem.POIFSStream
- All Implemented Interfaces:
Iterable<ByteBuffer>
This handles reading and writing a stream within a
POIFSFileSystem
. It can supply an iterator
to read blocks, and way to write out to existing and
new blocks.
Most users will want a higher level version of this,
which deals with properties to track which stream
this is.
This only works on big block streams, it doesn't
handle small block ones.
This uses the new NIO code
TODO Implement a streaming write method, and append-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected class
protected class
Class that handles a streaming read of one stream -
Constructor Summary
ConstructorsConstructorDescriptionPOIFSStream
(BlockStore blockStore) Constructor for a new stream.POIFSStream
(BlockStore blockStore, int startBlock) Constructor for an existing stream. -
Method Summary
Modifier and TypeMethodDescriptionvoid
free()
Frees all blocks in the streamint
What block does this stream start at? Will bePOIFSConstants.END_OF_CHAIN
for a new stream that hasn't been written to yet.iterator()
Returns an iterator that'll supply oneByteBuffer
per block in the stream.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 Details
-
POIFSStream
Constructor for an existing stream. It's up to you to know how to get the start block (eg from aHeaderBlock
or aProperty
) -
POIFSStream
Constructor for a new stream. A start block won't be allocated until you begin writing to it.
-
-
Method Details
-
getStartBlock
public int getStartBlock()What block does this stream start at? Will bePOIFSConstants.END_OF_CHAIN
for a new stream that hasn't been written to yet. -
iterator
Returns an iterator that'll supply oneByteBuffer
per block in the stream.- Specified by:
iterator
in interfaceIterable<ByteBuffer>
-
getOutputStream
- Throws:
IOException
-
free
Frees all blocks in the stream- Throws:
IOException
-