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

DirectoryEntry

public interface DirectoryEntry implements Entry
This interface defines methods specific to Directory objects managed by a Filesystem instance.
author
Marc Johnson (mjohnson at apache dot org)

Fields Summary
Constructors Summary
Methods Summary
public org.apache.poi.poifs.filesystem.DirectoryEntrycreateDirectory(java.lang.String name)
create a new DirectoryEntry

param
name the name of the new DirectoryEntry
return
the new DirectoryEntry
exception
IOException

public org.apache.poi.poifs.filesystem.DocumentEntrycreateDocument(java.lang.String name, java.io.InputStream stream)
create a new DocumentEntry

param
name the name of the new DocumentEntry
param
stream the InputStream from which to create the new DocumentEntry
return
the new DocumentEntry
exception
IOException

public org.apache.poi.poifs.filesystem.DocumentEntrycreateDocument(java.lang.String name, int size, org.apache.poi.poifs.filesystem.POIFSWriterListener writer)
create a new DocumentEntry; the data will be provided later

param
name the name of the new DocumentEntry
param
size the size of the new DocumentEntry
param
writer the writer of the new DocumentEntry
return
the new DocumentEntry
exception
IOException

public java.util.IteratorgetEntries()
get an iterator of the Entry instances contained directly in this instance (in other words, children only; no grandchildren etc.)

return
iterator; never null, but hasNext() may return false immediately (i.e., this DirectoryEntry is empty). All objects retrieved by next() are guaranteed to be implementations of Entry.

public org.apache.poi.poifs.filesystem.EntrygetEntry(java.lang.String name)
get a specified Entry by name

param
name the name of the Entry to obtain.
return
the specified Entry, if it is directly contained in this DirectoryEntry
exception
FileNotFoundException if no Entry with the specified name exists in this DirectoryEntry

public intgetEntryCount()
find out how many Entry instances are contained directly within this DirectoryEntry

return
number of immediately (no grandchildren etc.) contained Entry instances

public org.apache.poi.hpsf.ClassIDgetStorageClsid()
Gets the storage clsid of the directory entry

return
storage Class ID

public booleanisEmpty()
is this DirectoryEntry empty?

return
true if this instance contains no Entry instances

public voidsetStorageClsid(org.apache.poi.hpsf.ClassID clsidStorage)
Sets the storage clsid for the directory entry

param
clsidStorage storage Class ID