Package org.apache.poi.poifs.filesystem

Class POIFSDocument

java.lang.Object

org.apache.poi.poifs.filesystem.POIFSDocument

All Implemented Interfaces:

Iterable<ByteBuffer>, POIFSViewable

public final class POIFSDocument
extends Object
implements POIFSViewable, Iterable<ByteBuffer>

This class manages a document in the NIO POIFS filesystem. This is the POIFSFileSystem version.

Constructor Summary

Constructors

Constructor	Description
POIFSDocument(String name, int size, POIFSFileSystem filesystem, POIFSWriterListener writer)
POIFSDocument(String name, POIFSFileSystem filesystem, InputStream stream)	Constructor for a new Document
POIFSDocument(DocumentNode document)	Constructor for an existing Document
POIFSDocument(DocumentProperty property, POIFSFileSystem filesystem)	Constructor for an existing Document

Method Summary

Modifier and Type	Method	Description
String	getShortDescription()	Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.
int	getSize()
Object[]	getViewableArray()	Get an array of objects, some of which may implement POIFSViewable
Iterator<Object>	getViewableIterator()	Get an Iterator of objects, some of which may implement POIFSViewable
Iterator<ByteBuffer>	iterator()
boolean	preferArray()	Give viewers a hint as to whether to call getViewableArray or getViewableIterator
void	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 Detail

POIFSDocument

public POIFSDocument(DocumentNode document)

Constructor for an existing Document

POIFSDocument

public POIFSDocument(DocumentProperty property,
                     POIFSFileSystem filesystem)

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 POIFSDocument

stream - the InputStream we read data from

Throws:

IOException

POIFSDocument

public POIFSDocument(String name,
                     int size,
                     POIFSFileSystem filesystem,
                     POIFSWriterListener writer)
              throws IOException

Throws:

IOException

Method Detail

iterator

public Iterator<ByteBuffer> iterator()

Specified by:

iterator in interface Iterable<ByteBuffer>

getSize

public int getSize()

Returns:

size of the document

replaceContents

public void replaceContents(InputStream stream)
                     throws IOException

Throws:

IOException

getViewableArray

public Object[] getViewableArray()

Get an array of objects, some of which may implement POIFSViewable

Specified by:

getViewableArray in interface POIFSViewable

Returns:

an array of Object; may not be null, but may be empty

getViewableIterator

public Iterator<Object> getViewableIterator()

Get an Iterator of objects, some of which may implement POIFSViewable

Specified by:

getViewableIterator in interface POIFSViewable

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 interface POIFSViewable

Returns:

true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator

getShortDescription

public String getShortDescription()

Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.

Specified by:

getShortDescription in interface POIFSViewable

Returns:

short description