Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache.poi.poifs » filesystem » [javadoc | source]
org.apache.poi.poifs.filesystem
public interface: Entry [javadoc | source]

All Known Implementing Classes:
    DocumentEntry, DirectoryEntry, EntryNode, DocumentNode, DirectoryNode

This interface provides access to an object managed by a Filesystem instance. Entry objects are further divided into DocumentEntry and DirectoryEntry instances.
Method from org.apache.poi.poifs.filesystem.Entry Summary:
delete,   getName,   getParent,   isDirectoryEntry,   isDocumentEntry,   renameTo
Method from org.apache.poi.poifs.filesystem.Entry 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 DirectoryEntry that owns this
Entry). All Entry objects, except the root Entry, has a parent.
 public boolean isDirectoryEntry()
    is this a DirectoryEntry?
 public boolean isDocumentEntry()
    is this a DocumentEntry?
 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.