Top Description Methods
org.apache.poi.poifs.filesystem

public Interface Entry

Known Direct Subinterfaces
org.apache.poi.poifs.filesystem.DirectoryEntry, org.apache.poi.poifs.filesystem.DocumentEntry
Known Direct Implementers
org.apache.poi.poifs.filesystem.EntryNode

This interface provides access to an object managed by a Filesystem instance. Entry objects are further divided into DocumentEntry and DirectoryEntry instances.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the Entry was successfully deleted, else false
delete
()

Delete this Entry.

public String

Returns:

name
getName
()

get the name of the Entry

public DirectoryEntry

Returns:

this Entry's parent; null iff this is the root Entry
getParent
()

get this Entry's parent (the DirectoryEntry that owns this Entry).

public boolean

Returns:

true if the Entry is a DirectoryEntry, else false
isDirectoryEntry
()

is this a DirectoryEntry?

public boolean

Returns:

true if the Entry is a DocumentEntry, else false
isDocumentEntry
()

is this a DocumentEntry?

public boolean

Returns:

true if the operation succeeded, else false
renameTo
(final String
the new name for this Entry
newName
)

Rename this Entry.

Method Detail

deleteback to summary
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.

Returns:boolean

true if the Entry was successfully deleted, else false

getNameback to summary
public String getName()

get the name of the Entry

Returns:String

name

getParentback to summary
public DirectoryEntry getParent()

get this Entry's parent (the DirectoryEntry that owns this Entry). All Entry objects, except the root Entry, has a parent.

Returns:DirectoryEntry

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

isDirectoryEntryback to summary
public boolean isDirectoryEntry()

is this a DirectoryEntry?

Returns:boolean

true if the Entry is a DirectoryEntry, else false

isDocumentEntryback to summary
public boolean isDocumentEntry()

is this a DocumentEntry?

Returns:boolean

true if the Entry is a DocumentEntry, else false

renameToback to summary
public boolean renameTo(final 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.

Parameters
newName:String

the new name for this Entry

Returns:boolean

true if the operation succeeded, else false