Package org.apache.poi.poifs.filesystem
Class POIFSDocument
java.lang.Object
org.apache.poi.poifs.filesystem.POIFSDocument
- All Implemented Interfaces:
Iterable<ByteBuffer>
,POIFSViewable
This class manages a document in the NIO POIFS filesystem.
This is the
POIFSFileSystem
version.-
Constructor Summary
ConstructorsConstructorDescriptionPOIFSDocument
(String name, int size, POIFSFileSystem filesystem, POIFSWriterListener writer) POIFSDocument
(String name, POIFSFileSystem filesystem, InputStream stream) Constructor for a new DocumentPOIFSDocument
(DocumentNode document) Constructor for an existing DocumentPOIFSDocument
(DocumentProperty property, POIFSFileSystem filesystem) Constructor for an existing Document -
Method Summary
Modifier and TypeMethodDescriptionProvides a short description of the object, to be used when a POIFSViewable object has not provided its contents.int
getSize()
Object[]
Get an array of objects, some of which may implement POIFSViewableGet an Iterator of objects, some of which may implement POIFSViewableiterator()
boolean
Give viewers a hint as to whether to call getViewableArray or getViewableIteratorvoid
replaceContents
(InputStream 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
-
POIFSDocument
Constructor for an existing Document -
POIFSDocument
Constructor for an existing Document -
POIFSDocument
public POIFSDocument(String name, POIFSFileSystem filesystem, InputStream stream) throws IOException Constructor for a new Document- Parameters:
name
- the name of the POIFSDocumentstream
- the InputStream we read data from- Throws:
IOException
-
POIFSDocument
public POIFSDocument(String name, int size, POIFSFileSystem filesystem, POIFSWriterListener writer) throws IOException - Throws:
IOException
-
-
Method Details
-
iterator
- Specified by:
iterator
in interfaceIterable<ByteBuffer>
-
getSize
public int getSize()- Returns:
- size of the document
-
replaceContents
- Throws:
IOException
-
getViewableArray
Get an array of objects, some of which may implement POIFSViewable- Specified by:
getViewableArray
in interfacePOIFSViewable
- Returns:
- an array of Object; may not be null, but may be empty
-
getViewableIterator
Get an Iterator of objects, some of which may implement POIFSViewable- Specified by:
getViewableIterator
in interfacePOIFSViewable
- Returns:
- an Iterator; may not be null, but may have an empty back end store
-
preferArray
public boolean preferArray()Give viewers a hint as to whether to call getViewableArray or getViewableIterator- Specified by:
preferArray
in interfacePOIFSViewable
- Returns:
true
if a viewer should call getViewableArray,false
if a viewer should call getViewableIterator
-
getShortDescription
Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.- Specified by:
getShortDescription
in interfacePOIFSViewable
- Returns:
- short description
-