|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.poifs.filesystem.POIFSDocument
public class POIFSDocument
This class manages a document in the POIFS filesystem.
| Constructor Summary | |
|---|---|
POIFSDocument(java.lang.String name,
java.io.InputStream stream)
Constructor |
|
POIFSDocument(java.lang.String name,
int size,
POIFSDocumentPath path,
POIFSWriterListener writer)
Constructor |
|
POIFSDocument(java.lang.String name,
ListManagedBlock[] blocks,
int length)
Constructor from small blocks |
|
POIFSDocument(java.lang.String name,
RawDataBlock[] blocks,
int length)
Constructor from large blocks |
|
POIFSDocument(java.lang.String name,
SmallDocumentBlock[] blocks,
int length)
Constructor from small blocks |
|
| Method Summary | |
|---|---|
int |
countBlocks()
Return the number of BigBlock's this instance uses |
java.lang.String |
getShortDescription()
Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents. |
int |
getSize()
|
BlockWritable[] |
getSmallBlocks()
return the array of SmallDocumentBlocks used |
java.lang.Object[] |
getViewableArray()
Get an array of objects, some of which may implement POIFSViewable |
java.util.Iterator |
getViewableIterator()
Get an Iterator of objects, some of which may implement POIFSViewable |
boolean |
preferArray()
Give viewers a hint as to whether to call getViewableArray or getViewableIterator |
void |
setStartBlock(int index)
Set the start block for this instance |
void |
writeBlocks(java.io.OutputStream stream)
Write the storage to an OutputStream |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public POIFSDocument(java.lang.String name,
RawDataBlock[] blocks,
int length)
throws java.io.IOException
name - the name of the POIFSDocumentblocks - the big blocks making up the POIFSDocumentlength - the actual length of the POIFSDocument
java.io.IOException
public POIFSDocument(java.lang.String name,
SmallDocumentBlock[] blocks,
int length)
name - the name of the POIFSDocumentblocks - the small blocks making up the POIFSDocumentlength - the actual length of the POIFSDocument
public POIFSDocument(java.lang.String name,
ListManagedBlock[] blocks,
int length)
throws java.io.IOException
name - the name of the POIFSDocumentblocks - the small blocks making up the POIFSDocumentlength - the actual length of the POIFSDocument
java.io.IOException
public POIFSDocument(java.lang.String name,
java.io.InputStream stream)
throws java.io.IOException
name - the name of the POIFSDocumentstream - the InputStream we read data from
java.io.IOException - thrown on read errors
public POIFSDocument(java.lang.String name,
int size,
POIFSDocumentPath path,
POIFSWriterListener writer)
throws java.io.IOException
name - the name of the POIFSDocumentsize - the length of the POIFSDocumentpath - the path of the POIFSDocumentwriter - the writer who will eventually write the document
contents
java.io.IOException - thrown on read errors| Method Detail |
|---|
public BlockWritable[] getSmallBlocks()
public int getSize()
public void writeBlocks(java.io.OutputStream stream)
throws java.io.IOException
writeBlocks in interface BlockWritablestream - the OutputStream to which the stored data should
be written
java.io.IOException - on problems writing to the specified
streampublic int countBlocks()
countBlocks in interface BATManagedpublic void setStartBlock(int index)
setStartBlock in interface BATManagedindex - index into the array of blocks making up the
filesystempublic java.lang.Object[] getViewableArray()
getViewableArray in interface POIFSViewablepublic java.util.Iterator getViewableIterator()
getViewableIterator in interface POIFSViewablepublic boolean preferArray()
preferArray in interface POIFSViewablepublic java.lang.String getShortDescription()
getShortDescription in interface POIFSViewable
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||