|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.poifs.filesystem.EntryNode | +--org.apache.poi.poifs.filesystem.DirectoryNode
Simple implementation of DirectoryEntry
Method Summary | |
DirectoryEntry |
createDirectory(java.lang.String name)
create a new DirectoryEntry |
DocumentEntry |
createDocument(java.lang.String name,
java.io.InputStream stream)
create a new DocumentEntry |
DocumentEntry |
createDocument(java.lang.String name,
int size,
POIFSWriterListener writer)
create a new DocumentEntry; the data will be provided later |
java.util.Iterator |
getEntries()
get an iterator of the Entry instances contained directly in this instance (in other words, children only; no grandchildren etc.) |
Entry |
getEntry(java.lang.String name)
get a specified Entry by name |
int |
getEntryCount()
find out how many Entry instances are contained directly within this DirectoryEntry |
POIFSDocumentPath |
getPath()
|
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 |
protected boolean |
isDeleteOK()
extensions use this method to verify internal rules regarding deletion of the underlying store. |
boolean |
isDirectoryEntry()
is this a DirectoryEntry? |
boolean |
isEmpty()
is this DirectoryEntry empty? |
boolean |
preferArray()
Give viewers a hint as to whether to call getViewableArray or getViewableIterator |
Methods inherited from class org.apache.poi.poifs.filesystem.EntryNode |
delete, getName, getParent, getProperty, isDocumentEntry, isRoot, renameTo |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.poi.poifs.filesystem.Entry |
delete, getName, getParent, isDocumentEntry, renameTo |
Method Detail |
public POIFSDocumentPath getPath()
public java.util.Iterator getEntries()
getEntries
in interface DirectoryEntry
public boolean isEmpty()
isEmpty
in interface DirectoryEntry
public int getEntryCount()
getEntryCount
in interface DirectoryEntry
public Entry getEntry(java.lang.String name) throws java.io.FileNotFoundException
getEntry
in interface DirectoryEntry
name
- the name of the Entry to obtain.java.io.FileNotFoundException
- if no Entry with the specified
name exists in this DirectoryEntrypublic DocumentEntry createDocument(java.lang.String name, java.io.InputStream stream) throws java.io.IOException
createDocument
in interface DirectoryEntry
name
- the name of the new DocumentEntrystream
- the InputStream from which to create the new
DocumentEntryjava.io.IOException
- public DocumentEntry createDocument(java.lang.String name, int size, POIFSWriterListener writer) throws java.io.IOException
createDocument
in interface DirectoryEntry
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
createDirectory
in interface DirectoryEntry
name
- the name of the new DirectoryEntryjava.io.IOException
- public boolean isDirectoryEntry()
isDirectoryEntry
in interface Entry
isDirectoryEntry
in class EntryNode
protected boolean isDeleteOK()
isDeleteOK
in class EntryNode
public 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 |