|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.poifs.filesystem.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 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 datajava.io.IOException
- on errors reading, or on invalid dataMethod Detail |
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 POIFSDocumentjava.io.IOException
- on error creating the new POIFSDocumentpublic 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 DocumentEntryjava.io.IOException
- public DirectoryEntry createDirectory(java.lang.String name) throws java.io.IOException
name
- the name of the new DirectoryEntryjava.io.IOException
- on name duplicationpublic void writeFilesystem(java.io.OutputStream stream) throws java.io.IOException
stream
- the OutputStream to which the filesystem will be
writtenjava.io.IOException
- thrown on errors writing to the streampublic 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 filejava.io.IOException
- public DirectoryEntry getRoot()
public DocumentInputStream createDocumentInputStream(java.lang.String documentName) throws java.io.IOException
documentName
- the name of the document to be openedjava.io.IOException
- if the document does not exist or the
name is that of a DirectoryEntrypublic java.lang.Object[] getViewableArray()
getViewableArray
in interface POIFSViewable
public java.util.Iterator getViewableIterator()
getViewableIterator
in interface POIFSViewable
public boolean preferArray()
preferArray
in interface POIFSViewable
public java.lang.String getShortDescription()
getShortDescription
in interface POIFSViewable
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |