| java.lang.Object
 org.apache.poi.poifs.filesystem.POIFSDocument
| Constructor Summary | |
| public | POIFSDocument(String name, RawDataBlock[] blocks, int length)
| | public | POIFSDocument(String name, SmallDocumentBlock[] blocks, int length)
| | public | POIFSDocument(String name, ListManagedBlock[] blocks, int length)
| | public | POIFSDocument(String name, InputStream stream)
| | public | POIFSDocument(String name, int size, POIFSDocumentPath path, POIFSWriterListener writer)
|
| POIFSDocument | | public POIFSDocument(String name, RawDataBlock[] blocks, int length) throws IOException(Code) | | Constructor from large blocks
Parameters:
name - the name of the POIFSDocument
Parameters:
blocks - the big blocks making up the POIFSDocument
Parameters:
length - the actual length of the POIFSDocument
exception:
IOException - |
| POIFSDocument | | public POIFSDocument(String name, SmallDocumentBlock[] blocks, int length)(Code) | | Constructor from small blocks
Parameters:
name - the name of the POIFSDocument
Parameters:
blocks - the small blocks making up the POIFSDocument
Parameters:
length - the actual length of the POIFSDocument |
| POIFSDocument | | public POIFSDocument(String name, ListManagedBlock[] blocks, int length) throws IOException(Code) | | Constructor from small blocks
Parameters:
name - the name of the POIFSDocument
Parameters:
blocks - the small blocks making up the POIFSDocument
Parameters:
length - the actual length of the POIFSDocument
exception:
IOException - |
| POIFSDocument | | public POIFSDocument(String name, InputStream stream) throws IOException(Code) | | Constructor
Parameters:
name - the name of the POIFSDocument
Parameters:
stream - the InputStream we read data from
exception:
IOException - thrown on read errors |
| POIFSDocument | | public POIFSDocument(String name, int size, POIFSDocumentPath path, POIFSWriterListener writer) throws IOException(Code) | | Constructor
Parameters:
name - the name of the POIFSDocument
Parameters:
size - the length of the POIFSDocument
Parameters:
path - the path of the POIFSDocument
Parameters:
writer - the writer who will eventually write the documentcontents
exception:
IOException - thrown on read errors |
| countBlocks | | public int countBlocks()(Code) | | Return the number of BigBlock's this instance uses
count of BigBlock instances |
| getDocumentProperty | | DocumentProperty getDocumentProperty()(Code) | | Get the DocumentProperty
the instance's DocumentProperty |
| getShortDescription | | public String getShortDescription()(Code) | | Provides a short description of the object, to be used when a
POIFSViewable object has not provided its contents.
short description |
| getSize | | public int getSize()(Code) | | size of the document |
| getSmallBlocks | | public BlockWritable[] getSmallBlocks()(Code) | | return the array of SmallDocumentBlocks used
array of SmallDocumentBlocks; may be empty, cannot be null |
| getViewableArray | | public Object[] getViewableArray()(Code) | | Get an array of objects, some of which may implement
POIFSViewable
an array of Object; may not be null, but may be empty |
| getViewableIterator | | public Iterator getViewableIterator()(Code) | | Get an Iterator of objects, some of which may implement
POIFSViewable
an Iterator; may not be null, but may have an emptyback end store |
| preferArray | | public boolean preferArray()(Code) | | Give viewers a hint as to whether to call getViewableArray or
getViewableIterator
true if a viewer should call getViewableArray, false ifa viewer should call getViewableIterator |
| read | | void read(byte[] buffer, int offset)(Code) | | read data from the internal stores
Parameters:
buffer - the buffer to write to
Parameters:
offset - the offset into our storage to read from |
| setStartBlock | | public void setStartBlock(int index)(Code) | | Set the start block for this instance
Parameters:
index - index into the array of blocks making up thefilesystem |
| writeBlocks | | public void writeBlocks(OutputStream stream) throws IOException(Code) | | Write the storage to an OutputStream
Parameters:
stream - the OutputStream to which the stored data shouldbe written
exception:
IOException - on problems writing to the specifiedstream |
|
|