Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache.poi.poifs » filesystem » [javadoc | source]
org.apache.poi.poifs.filesystem
abstract public class: EntryNode [javadoc | source]
java.lang.Object
   org.apache.poi.poifs.filesystem.EntryNode

All Implemented Interfaces:
    Entry

Direct Known Subclasses:
    DocumentNode, DirectoryNode

Abstract implementation of Entry Extending classes should override isDocument() or isDirectory(), as appropriate Extending classes must override isDeleteOK()
Constructor:
 protected EntryNode(Property property,
    DirectoryNode parent) 
    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
    parent - the parent of this entry
Method from org.apache.poi.poifs.filesystem.EntryNode Summary:
delete,   getName,   getParent,   getProperty,   isDeleteOK,   isDirectoryEntry,   isDocumentEntry,   isRoot,   renameTo
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.poifs.filesystem.EntryNode Detail:
 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.
 public String getName() 
    get the name of the Entry
 public DirectoryEntry getParent() 
    get this Entry's parent (the DocumentEntry that owns this Entry). All Entry objects, except the root Entry, has a parent.
 protected Property getProperty() 
    grant access to the property
 abstract protected boolean isDeleteOK()
    extensions use this method to verify internal rules regarding deletion of the underlying store.
 public boolean isDirectoryEntry() 
    is this a DirectoryEntry?
 public boolean isDocumentEntry() 
    is this a DocumentEntry?
 protected boolean isRoot() 
    is this the root of the tree?
 public boolean renameTo(String newName) 
    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.