| java.lang.Object
 org.apache.poi.poifs.filesystem.EntryNode
org.apache.poi.poifs.filesystem.DirectoryNode
| DirectoryNode | | DirectoryNode(DirectoryProperty property, POIFSFileSystem filesystem, DirectoryNode parent)(Code) | | create a DirectoryNode. This method is not public by design; it
is intended strictly for the internal use of this package
Parameters:
property - the DirectoryProperty for this DirectoryEntry
Parameters:
filesystem - the POIFSFileSystem we belong to
Parameters:
parent - the parent of this entry |
| changeName | | boolean changeName(String oldName, String newName)(Code) | | Change a contained Entry's name
Parameters:
oldName - the original name
Parameters:
newName - the new name true if the operation succeeded, else false |
| 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 - |
| deleteEntry | | boolean deleteEntry(EntryNode entry)(Code) | | Delete an entry
Parameters:
entry - the EntryNode to be deleted true if the entry was deleted, else false |
| 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 |
| getShortDescription | | public String getShortDescription()(Code) | | Provides a short description of the object, to be used when a
POIFSViewable object has not provided its contents.
short description |
| getStorageClsid | | public ClassID getStorageClsid()(Code) | | Gets the storage clsid of the directory entry
storage Class ID |
| getViewableArray | | public Object[] getViewableArray()(Code) | | Get an array of objects, some of which may implement
POIFSViewable
an array of Object; may not be null, but may be empty |
| getViewableIterator | | public Iterator getViewableIterator()(Code) | | Get an Iterator of objects, some of which may implement
POIFSViewable
an Iterator; may not be null, but may have an emptyback end store |
| isDeleteOK | | protected boolean isDeleteOK()(Code) | | extensions use this method to verify internal rules regarding
deletion of the underlying store.
true if it's ok to delete the underlying store, elsefalse |
| isDirectoryEntry | | public boolean isDirectoryEntry()(Code) | | is this a DirectoryEntry?
true if the Entry is a DirectoryEntry, else false |
| isEmpty | | public boolean isEmpty()(Code) | | is this DirectoryEntry empty?
true if this instance contains no Entry instances |
| preferArray | | public boolean preferArray()(Code) | | Give viewers a hint as to whether to call getViewableArray or
getViewableIterator
true if a viewer should call getViewableArray, false ifa viewer should call getViewableIterator |
| setStorageClsid | | public void setStorageClsid(ClassID clsidStorage)(Code) | | Sets the storage clsid for the directory entry
Parameters:
clsidStorage - storage Class ID |
|
|