Package org.apache.poi.poifs.filesystem
Class DocumentNode
java.lang.Object
org.apache.poi.poifs.filesystem.EntryNode
org.apache.poi.poifs.filesystem.DocumentNode
- All Implemented Interfaces:
POIFSViewable
,DocumentEntry
,Entry
Simple implementation of DocumentEntry for OPOIFS
-
Method Summary
Modifier and TypeMethodDescriptionProvides a short description of the object, to be used when a POIFSViewable object has not provided its contents.int
getSize()
get the zize of the document, in bytesObject[]
Get an array of objects, some of which may implement POIFSViewableGet an Iterator of objects, some of which may implement POIFSViewableprotected boolean
extensions use this method to verify internal rules regarding deletion of the underlying store.boolean
is this a DocumentEntry?boolean
Give viewers a hint as to whether to call getViewableArray or getViewableIteratorMethods inherited from class org.apache.poi.poifs.filesystem.EntryNode
delete, getName, getParent, getProperty, isDirectoryEntry, isRoot, renameTo
-
Method Details
-
getSize
public int getSize()get the zize of the document, in bytes- Specified by:
getSize
in interfaceDocumentEntry
- Returns:
- size in bytes
-
isDocumentEntry
public boolean isDocumentEntry()is this a DocumentEntry?- Specified by:
isDocumentEntry
in interfaceEntry
- Overrides:
isDocumentEntry
in classEntryNode
- Returns:
- true if the Entry is a DocumentEntry, else false
-
isDeleteOK
protected boolean isDeleteOK()extensions use this method to verify internal rules regarding deletion of the underlying store.- Specified by:
isDeleteOK
in classEntryNode
- Returns:
- true if it's ok to delete the underlying store, else false
-
getViewableArray
Get an array of objects, some of which may implement POIFSViewable- Specified by:
getViewableArray
in interfacePOIFSViewable
- Returns:
- an array of Object; may not be null, but may be empty
-
getViewableIterator
Get an Iterator of objects, some of which may implement POIFSViewable- Specified by:
getViewableIterator
in interfacePOIFSViewable
- Returns:
- an Iterator; may not be null, but may have an empty back end store
-
preferArray
public boolean preferArray()Give viewers a hint as to whether to call getViewableArray or getViewableIterator- Specified by:
preferArray
in interfacePOIFSViewable
- Returns:
- true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator
-
getShortDescription
Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.- Specified by:
getShortDescription
in interfacePOIFSViewable
- Returns:
- short description
-