|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.poifs.filesystem.POIFSFileSystem
public class POIFSFileSystem
This is the main class of the POIFS system; it manages the entire life cycle of the filesystem.
| Constructor Summary | |
|---|---|
POIFSFileSystem()
Constructor, intended for writing |
|
POIFSFileSystem(java.io.InputStream stream)
Create a POIFSFileSystem from an InputStream |
|
| Method Summary | |
|---|---|
DirectoryEntry |
createDirectory(java.lang.String name)
create a new DirectoryEntry in the root directory |
DocumentEntry |
createDocument(java.io.InputStream stream,
java.lang.String name)
Create a new document to be added to the root directory |
DocumentEntry |
createDocument(java.lang.String name,
int size,
POIFSWriterListener writer)
create a new DocumentEntry in the root entry; the data will be provided later |
DocumentInputStream |
createDocumentInputStream(java.lang.String documentName)
open a document in the root entry's list of entries |
DirectoryEntry |
getRoot()
get the root entry |
java.lang.String |
getShortDescription()
Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents. |
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 |
static boolean |
hasPOIFSHeader(java.io.InputStream inp)
Checks that the supplied InputStream (which MUST support mark and reset, or be a PushbackInputStream) has a POIFS (OLE2) header at the start of it. |
static void |
main(java.lang.String[] args)
read in a file and write it back out again |
boolean |
preferArray()
Give viewers a hint as to whether to call getViewableArray or getViewableIterator |
void |
writeFilesystem(java.io.OutputStream stream)
Write the filesystem out |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public POIFSFileSystem()
public POIFSFileSystem(java.io.InputStream stream)
throws java.io.IOException
stream - the InputStream from which to read the data
java.io.IOException - on errors reading, or on invalid data| Method Detail |
|---|
public static boolean hasPOIFSHeader(java.io.InputStream inp)
throws java.io.IOException
inp - An InputStream which supports either mark/reset, or is a PushbackInputStream
java.io.IOException
public DocumentEntry createDocument(java.io.InputStream stream,
java.lang.String name)
throws java.io.IOException
stream - the InputStream from which the document's data
will be obtainedname - the name of the new POIFSDocument
java.io.IOException - on error creating the new POIFSDocument
public DocumentEntry createDocument(java.lang.String name,
int size,
POIFSWriterListener writer)
throws java.io.IOException
name - the name of the new DocumentEntrysize - the size of the new DocumentEntrywriter - the writer of the new DocumentEntry
java.io.IOException
public DirectoryEntry createDirectory(java.lang.String name)
throws java.io.IOException
name - the name of the new DirectoryEntry
java.io.IOException - on name duplication
public void writeFilesystem(java.io.OutputStream stream)
throws java.io.IOException
stream - the OutputStream to which the filesystem will be
written
java.io.IOException - thrown on errors writing to the stream
public static void main(java.lang.String[] args)
throws java.io.IOException
args - names of the files; arg[ 0 ] is the input file,
arg[ 1 ] is the output file
java.io.IOExceptionpublic DirectoryEntry getRoot()
public DocumentInputStream createDocumentInputStream(java.lang.String documentName)
throws java.io.IOException
documentName - the name of the document to be opened
java.io.IOException - if the document does not exist or the
name is that of a DirectoryEntrypublic 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 | |||||||||