| org.apache.poi.poifs.filesystem.DirectoryEntry
All known Subclasses: org.apache.poi.poifs.filesystem.DirectoryNode,
| DirectoryEntry | | public interface DirectoryEntry extends Entry(Code) | | This interface defines methods specific to Directory objects
managed by a Filesystem instance.
author:
Marc Johnson (mjohnson at apache dot org) |
| createDocument | | public DocumentEntry createDocument(String name, InputStream stream) throws IOException(Code) | | create a new DocumentEntry
Parameters:
name - the name of the new DocumentEntry
Parameters:
stream - the InputStream from which to create the newDocumentEntry the new DocumentEntry
exception:
IOException - |
| createDocument | | public DocumentEntry createDocument(String name, int size, POIFSWriterListener writer) throws IOException(Code) | | create a new DocumentEntry; the data will be provided later
Parameters:
name - the name of the new DocumentEntry
Parameters:
size - the size of the new DocumentEntry
Parameters:
writer - the writer of the new DocumentEntry the new DocumentEntry
exception:
IOException - |
| getEntries | | public Iterator getEntries()(Code) | | get an iterator of the Entry instances contained directly in
this instance (in other words, children only; no grandchildren
etc.)
iterator; never null, but hasNext() may return falseimmediately (i.e., this DirectoryEntry is empty). Allobjects retrieved by next() are guaranteed to beimplementations of Entry. |
| getEntry | | public Entry getEntry(String name) throws FileNotFoundException(Code) | | get a specified Entry by name
Parameters:
name - the name of the Entry to obtain. the specified Entry, if it is directly contained inthis DirectoryEntry
exception:
FileNotFoundException - if no Entry with the specifiedname exists in this DirectoryEntry |
| getEntryCount | | public int getEntryCount()(Code) | | find out how many Entry instances are contained directly within
this DirectoryEntry
number of immediately (no grandchildren etc.) containedEntry instances |
| getStorageClsid | | public ClassID getStorageClsid()(Code) | | Gets the storage clsid of the directory entry
storage Class ID |
| isEmpty | | public boolean isEmpty()(Code) | | is this DirectoryEntry empty?
true if this instance contains no Entry instances |
| setStorageClsid | | public void setStorageClsid(ClassID clsidStorage)(Code) | | Sets the storage clsid for the directory entry
Parameters:
clsidStorage - storage Class ID |
|
|