FileDocCategorySizeDatePackage
Entry.javaAPI DocApache Poi 3.0.12949Mon Jan 01 12:39:34 GMT 2007org.apache.poi.poifs.filesystem

Entry

public interface Entry
This interface provides access to an object managed by a Filesystem instance. Entry objects are further divided into DocumentEntry and DirectoryEntry instances.
author
Marc Johnson (mjohnson at apache dot org)

Fields Summary
Constructors Summary
Methods Summary
public booleandelete()
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.

return
true if the Entry was successfully deleted, else false

public java.lang.StringgetName()
get the name of the Entry

return
name

public org.apache.poi.poifs.filesystem.DirectoryEntrygetParent()
get this Entry's parent (the DirectoryEntry that owns this Entry). All Entry objects, except the root Entry, has a parent.

return
this Entry's parent; null iff this is the root Entry

public booleanisDirectoryEntry()
is this a DirectoryEntry?

return
true if the Entry is a DirectoryEntry, else false

public booleanisDocumentEntry()
is this a DocumentEntry?

return
true if the Entry is a DocumentEntry, else false

public booleanrenameTo(java.lang.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.

param
newName the new name for this Entry
return
true if the operation succeeded, else false