| Modifier and Type | Field and Description |
|---|---|
| private final Map | |
| private final Map | |
| private final ArrayList | |
| private final POIFSFileSystem | |
| private final POIFSDocumentPath |
| Access | Constructor and Description |
|---|---|
| pack-priv | DirectoryNode(final DirectoryProperty
the DirectoryProperty for this DirectoryEntry property, final POIFSFileSystem the filesystem, final DirectoryNode POIFSFileSystem we belong tothe parent of this entry parent)create a DirectoryNode. |
| Modifier and Type | Method and Description |
|---|---|
| pack-priv boolean | Returns: true if the operation succeeded, else falsethe original name oldName, final String the new name newName)Change a contained Entry's name |
| public DirectoryEntry | Returns: the new DirectoryEntrythe name of the new DirectoryEntry name)Implements org. create a new DirectoryEntry |
| pack-priv DocumentEntry | Returns: the new DocumentEntrythe new document document)create a new DocumentEntry |
| public DocumentEntry | Returns: the new DocumentEntrythe name of the new DocumentEntry name, final InputStream the InputStream from which to create the new
DocumentEntry stream)Implements org. create a new DocumentEntry |
| public DocumentEntry | Returns: the new DocumentEntrythe name of the new DocumentEntry name, final int the size of the new DocumentEntry size, final POIFSWriterListener the writer of the new DocumentEntry writer)Implements org. create a new DocumentEntry; the data will be provided later |
| public DocumentInputStream | Returns: a newly opened DocumentInputStreamthe name of the document to be opened documentName)open a document in the directory's entry's list of entries |
| public DocumentInputStream | Returns: a newly opened DocumentInputStream or DocumentInputStreamthe document to be opened document)open a document in the directory's entry's list of entries |
| public DocumentEntry | Returns: the new or updated DocumentEntrythe name of the new or existing DocumentEntry name, final InputStream the InputStream from which to populate the DocumentEntry stream)Set the contents of a document, creating if needed, otherwise updating. |
| pack-priv boolean | Returns: true if the entry was deleted, else falsethe EntryNode to be deleted entry)Delete an entry |
| public Iterator | Returns: 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.Implements org. get an iterator of the Entry instances contained directly in this instance (in other words, children only; no grandchildren etc.) |
| public Entry | Returns: the specified Entry, if it is directly contained in this DirectoryEntrythe name of the Entry to obtain. name)Implements org. get a specified Entry by name, case sensitive |
| public Entry | Returns: the specified Entry, if it is directly contained in this DirectoryEntrythe name of the Entry to obtain. name)Implements org. get a specified Entry by name, case-insensitive |
| public int | Returns: number of immediately (no grandchildren etc.) contained Entry instancesImplements org. find out how many Entry instances are contained directly within this DirectoryEntry |
| public Set | Returns: the names of all the entries that may be retrieved with getEntry(String), which may be empty (if this DirectoryEntry is empty)Implements org. get the literal, case-sensitive names of all the Entries contained directly in this instance (in other words, names of children only; no grandchildren etc). |
| public POIFSFileSystem | |
| public POIFSDocumentPath | |
| public String | Returns: short descriptionImplements org. Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents. |
| public ClassID | Returns: storage Class IDImplements org. Gets the storage clsid of the directory entry |
| public Object[] | Returns: an array of Object; may not be null, but may be emptyImplements org. Get an array of objects, some of which may implement POIFSViewable |
| public Iterator | Returns: an Iterator; may not be null, but may have an empty back end storeImplements org. Get an Iterator of objects, some of which may implement POIFSViewable |
| public boolean | Returns: whether or not an entry exists for that name (case-sensitive)Implements org. Checks for a specific entry in a case-sensitive way. |
| public boolean | Returns: whether or not an entry exists for that name (case-insensitive)Implements org. Checks for a specific entry in a case-insensitive way. |
| protected boolean | Returns: true if it's ok to delete the underlying store, else falseImplements abstract org. extensions use this method to verify internal rules regarding deletion of the underlying store. |
| public boolean | Returns: true if the Entry is a DirectoryEntry, else falseOverrides org. Implements org. is this a DirectoryEntry? |
| public boolean | Returns: true if this instance contains no Entry instancesImplements org. is this DirectoryEntry empty? |
| public Iterator | |
| public boolean | Returns: true if a viewer should call getViewableArray, false if a viewer should call getViewableIteratorImplements org. Give viewers a hint as to whether to call getViewableArray or getViewableIterator |
| public void | setStorageClsid(ClassID
storage Class ID clsidStorage)Implements org. Sets the storage clsid for the directory entry |
| public Spliterator | spliterator()
Overrides default java. Returns a Spliterator over all the entries |
| _byname | back to summary |
|---|---|
| private final Map<String, Entry> _byname | |
| _byUCName | back to summary |
|---|---|
| private final Map<String, Entry> _byUCName | |
| _entries | back to summary |
|---|---|
| private final ArrayList<Entry> _entries | |
| _filesystem | back to summary |
|---|---|
| private final POIFSFileSystem _filesystem | |
| _path | back to summary |
|---|---|
| private final POIFSDocumentPath _path | |
| DirectoryNode | back to summary |
|---|---|
| pack-priv DirectoryNode(final DirectoryProperty property, final POIFSFileSystem filesystem, final DirectoryNode parent) create a DirectoryNode. This method is not public by design; it is intended strictly for the internal use of this package
| |
| changeName | back to summary |
|---|---|
| pack-priv boolean changeName(final String oldName, final String newName) Change a contained Entry's name | |
| createDirectory | back to summary |
|---|---|
| public DirectoryEntry createDirectory(final String name) throws IOException Implements org. create a new DirectoryEntry
| |
| createDocument | back to summary |
|---|---|
| pack-priv DocumentEntry createDocument(final POIFSDocument document) throws IOException create a new DocumentEntry
| |
| createDocument | back to summary |
|---|---|
| public DocumentEntry createDocument(final String name, final InputStream stream) throws IOException Implements org. create a new DocumentEntry
| |
| createDocument | back to summary |
|---|---|
| public DocumentEntry createDocument(final String name, final int size, final POIFSWriterListener writer) throws IOException Implements org. create a new DocumentEntry; the data will be provided later
| |
| createDocumentInputStream | back to summary |
|---|---|
| public DocumentInputStream createDocumentInputStream(final String documentName) throws IOException open a document in the directory's entry's list of entries
| |
| createDocumentInputStream | back to summary |
|---|---|
| public DocumentInputStream createDocumentInputStream(final Entry document) throws IOException open a document in the directory's entry's list of entries
| |
| createOrUpdateDocument | back to summary |
|---|---|
| public DocumentEntry createOrUpdateDocument(final String name, final InputStream stream) throws IOException Set the contents of a document, creating if needed, otherwise updating. Returns the created / updated DocumentEntry
| |
| deleteEntry | back to summary |
|---|---|
| pack-priv boolean deleteEntry(final EntryNode entry) Delete an entry
| |
| getEntries | back to summary |
|---|---|
| public Iterator Implements org. get an iterator of the Entry instances contained directly in this instance (in other words, children only; no grandchildren etc.) | |
| getEntry | back to summary |
|---|---|
| public Entry getEntry(final String name) throws FileNotFoundException Implements org. get a specified Entry by name, case sensitive
| |
| getEntryCaseInsensitive | back to summary |
|---|---|
| public Entry getEntryCaseInsensitive(final String name) throws FileNotFoundException Implements org. get a specified Entry by name, case-insensitive
| |
| getEntryCount | back to summary |
|---|---|
| public int getEntryCount() Implements org. find out how many Entry instances are contained directly within this DirectoryEntry
| |
| getEntryNames | back to summary |
|---|---|
| public Set Implements org. get the literal, case-sensitive names of all the Entries contained directly in this instance (in other words, names of children only; no grandchildren etc). | |
| getFileSystem | back to summary |
|---|---|
public POIFSFileSystem getFileSystem()
| |
| getPath | back to summary |
|---|---|
public POIFSDocumentPath getPath()
| |
| getShortDescription | back to summary |
|---|---|
| public String getShortDescription() Implements org. Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents. | |
| getStorageClsid | back to summary |
|---|---|
| public ClassID getStorageClsid() Implements org. Gets the storage clsid of the directory entry | |
| getViewableArray | back to summary |
|---|---|
| public Object[] getViewableArray() Implements org. Get an array of objects, some of which may implement POIFSViewable | |
| getViewableIterator | back to summary |
|---|---|
| public Iterator Implements org. Get an Iterator of objects, some of which may implement POIFSViewable | |
| hasEntry | back to summary |
|---|---|
| public boolean hasEntry(String name) Implements org. Checks for a specific entry in a case-sensitive way.
| |
| hasEntryCaseInsensitive | back to summary |
|---|---|
| public boolean hasEntryCaseInsensitive(String name) Implements org. Checks for a specific entry in a case-insensitive way.
| |
| isDeleteOK | back to summary |
|---|---|
| protected boolean isDeleteOK() Implements abstract org. extensions use this method to verify internal rules regarding deletion of the underlying store.
| |
| isDirectoryEntry | back to summary |
|---|---|
| public boolean isDirectoryEntry() Overrides org. Implements org. is this a DirectoryEntry?
| |
| isEmpty | back to summary |
|---|---|
| public boolean isEmpty() Implements org. is this DirectoryEntry empty?
| |
| iterator | back to summary |
|---|---|
| public Iterator Implements java. Returns an Iterator over all the entries
| |
| preferArray | back to summary |
|---|---|
| public boolean preferArray() Implements org. Give viewers a hint as to whether to call getViewableArray or getViewableIterator
| |
| setStorageClsid | back to summary |
|---|---|
| public void setStorageClsid(ClassID clsidStorage) Implements org. Sets the storage clsid for the directory entry | |
| spliterator | back to summary |
|---|---|
| public Spliterator Overrides default java. Returns a Spliterator over all the entries
| |