|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DirectoryEntry
This interface defines methods specific to Directory objects managed by a Filesystem instance.
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<Entry> |
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 |
ClassID |
getStorageClsid()
Gets the storage clsid of the directory entry |
boolean |
hasEntry(java.lang.String name)
Checks if entry with specified name present |
boolean |
isEmpty()
is this DirectoryEntry empty? |
void |
setStorageClsid(ClassID clsidStorage)
Sets the storage clsid for the directory entry |
Methods inherited from interface org.apache.poi.poifs.filesystem.Entry |
---|
delete, getName, getParent, isDirectoryEntry, isDocumentEntry, renameTo |
Methods inherited from interface java.lang.Iterable |
---|
iterator |
Method Detail |
---|
java.util.Iterator<Entry> getEntries()
boolean isEmpty()
int getEntryCount()
boolean hasEntry(java.lang.String name)
Entry getEntry(java.lang.String name) throws java.io.FileNotFoundException
name
- the name of the Entry to obtain.
java.io.FileNotFoundException
- if no Entry with the specified
name exists in this DirectoryEntryDocumentEntry createDocument(java.lang.String name, java.io.InputStream stream) throws java.io.IOException
name
- the name of the new DocumentEntrystream
- the InputStream from which to create the new
DocumentEntry
java.io.IOException
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
DirectoryEntry createDirectory(java.lang.String name) throws java.io.IOException
name
- the name of the new DirectoryEntry
java.io.IOException
ClassID getStorageClsid()
void setStorageClsid(ClassID clsidStorage)
clsidStorage
- storage Class ID
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |