| java.lang.Object
 org.apache.poi.poifs.filesystem.EntryNode
All known Subclasses: org.apache.poi.poifs.filesystem.DocumentNode, org.apache.poi.poifs.filesystem.DirectoryNode,
| EntryNode | | abstract public class EntryNode implements Entry(Code) | | Abstract implementation of Entry
Extending classes should override isDocument() or isDirectory(), as
appropriate
Extending classes must override isDeleteOK()
author:
Marc Johnson (mjohnson at apache dot org) |
| EntryNode | | protected EntryNode(Property property, DirectoryNode parent)(Code) | | create a DocumentNode. This method is not public by design; it
is intended strictly for the internal use of extending classes
Parameters:
property - the Property for this Entry
Parameters:
parent - the parent of this entry |
| delete | | public boolean delete()(Code) | | Delete this Entry. This operation should succeed, but there are
special circumstances when it will not:
If this Entry is the root of the Entry tree, it cannot be
deleted, as there is no way to create another one.
If this Entry is a directory, it cannot be deleted unless it is
empty.
true if the Entry was successfully deleted, else false |
| getName | | public String getName()(Code) | | get the name of the Entry
name |
| getParent | | public DirectoryEntry getParent()(Code) | | get this Entry's parent (the DocumentEntry that owns this
Entry). All Entry objects, except the root Entry, has a parent.
this Entry's parent; null iff this is the root Entry |
| getProperty | | protected Property getProperty()(Code) | | grant access to the property
the property backing this entry |
| isDeleteOK | | abstract 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 |
| isDocumentEntry | | public boolean isDocumentEntry()(Code) | | is this a DocumentEntry?
true if the Entry is a DocumentEntry, else false |
| isRoot | | protected boolean isRoot()(Code) | | is this the root of the tree?
true if so, else false |
| renameTo | | public boolean renameTo(String newName)(Code) | | Rename this Entry. This operation will fail if:
There is a sibling Entry (i.e., an Entry whose parent is the
same as this Entry's parent) with the same name.
This Entry is the root of the Entry tree. Its name is dictated
by the Filesystem and many not be changed.
Parameters:
newName - the new name for this Entry true if the operation succeeded, else false |
|
|