Package org.apache.poi.poifs.filesystem
Class EntryNode
java.lang.Object
org.apache.poi.poifs.filesystem.EntryNode
- All Implemented Interfaces:
Entry
- Direct Known Subclasses:
DirectoryNode
,DocumentNode
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)
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
EntryNode
(Property property, DirectoryNode parent) create a DocumentNode. -
Method Summary
Modifier and TypeMethodDescriptionboolean
delete()
Delete this Entry.getName()
get the name of the Entryget this Entry's parent (the DocumentEntry that owns this Entry).protected Property
grant access to the propertyprotected abstract boolean
extensions use this method to verify internal rules regarding deletion of the underlying store.boolean
is this a DirectoryEntry?boolean
is this a DocumentEntry?protected boolean
isRoot()
is this the root of the tree?boolean
Rename this Entry.
-
Constructor Details
-
EntryNode
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 Entryparent
- the parent of this entry
-
-
Method Details
-
getProperty
grant access to the property- Returns:
- the property backing this entry
-
isRoot
protected boolean isRoot()is this the root of the tree?- Returns:
- true if so, else false
-
isDeleteOK
protected abstract boolean isDeleteOK()extensions use this method to verify internal rules regarding deletion of the underlying store.- Returns:
- true if it's ok to delete the underlying store, else false
-
getName
get the name of the Entry -
isDirectoryEntry
public boolean isDirectoryEntry()is this a DirectoryEntry?- Specified by:
isDirectoryEntry
in interfaceEntry
- Returns:
- true if the Entry is a DirectoryEntry, else false
-
isDocumentEntry
public boolean isDocumentEntry()is this a DocumentEntry?- Specified by:
isDocumentEntry
in interfaceEntry
- Returns:
- true if the Entry is a DocumentEntry, else false
-
getParent
get this Entry's parent (the DocumentEntry that owns this Entry). All Entry objects, except the root Entry, has a parent. -
delete
public boolean delete()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. -
renameTo
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.
-