Apache POI - Common 5.3.0 · org.apache.poi.poifs.filesystem.DocumentNode

Modifier and Type	Field and Description
private POIFSDocument	_document

Access	Constructor and Description
pack-priv	DocumentNode(final DocumentProperty the DocumentProperty for this DocumentEntry property, final DirectoryNode the parent of this entry parent) create a DocumentNode.

Method Summary

Modifier and Type	Method and Description
pack-priv POIFSDocument	Returns: the internal POIFSDocument getDocument() get the POIFSDocument
public String	Returns: short description getShortDescription() Implements org.apache.poi.poifs.dev.POIFSViewable.getShortDescription. Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.
public int	Returns: size in bytes getSize() Implements org.apache.poi.poifs.filesystem.DocumentEntry.getSize. get the zize of the document, in bytes
public Object[]	Returns: an array of Object; may not be null, but may be empty getViewableArray() Implements org.apache.poi.poifs.dev.POIFSViewable.getViewableArray. Get an array of objects, some of which may implement POIFSViewable
public Iterator<Object>	Returns: an Iterator; may not be null, but may have an empty back end store getViewableIterator() Implements org.apache.poi.poifs.dev.POIFSViewable.getViewableIterator. Get an Iterator of objects, some of which may implement POIFSViewable
protected boolean	Returns: true if it's ok to delete the underlying store, else false isDeleteOK() Implements abstract org.apache.poi.poifs.filesystem.EntryNode.isDeleteOK. extensions use this method to verify internal rules regarding deletion of the underlying store.
public boolean	Returns: true if the Entry is a DocumentEntry, else false isDocumentEntry() Overrides org.apache.poi.poifs.filesystem.EntryNode.isDocumentEntry. Implements org.apache.poi.poifs.filesystem.Entry.isDocumentEntry. is this a DocumentEntry?
public boolean	Returns: true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator preferArray() Implements org.apache.poi.poifs.dev.POIFSViewable.preferArray. Give viewers a hint as to whether to call getViewableArray or getViewableIterator

Inherited from org.apache.poi.poifs.filesystem.EntryNode:: delete getName getParent getProperty isDirectoryEntry isRoot renameTo

_document	back to summary
private POIFSDocument _document

DocumentNode	back to summary
pack-priv DocumentNode(final DocumentProperty property, final DirectoryNode parent) create a DocumentNode. This method is not public by design; it is intended strictly for the internal use of this package Parameters property:DocumentProperty the DocumentProperty for this DocumentEntry parent:DirectoryNode the parent of this entry

Method Detail

getDocument	back to summary
pack-priv POIFSDocument getDocument() get the POIFSDocument Returns:POIFSDocument the internal POIFSDocument

getDocument

back to summary

pack-priv POIFSDocument getDocument()

get the POIFSDocument

Returns:POIFSDocument: the internal POIFSDocument

getShortDescription	back to summary
public String getShortDescription() Implements org.apache.poi.poifs.dev.POIFSViewable.getShortDescription. Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents. Returns:String short description

getShortDescription

back to summary

public String getShortDescription()

Implements org.apache.poi.poifs.dev.POIFSViewable.getShortDescription.

Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.

Returns:String: short description

getSize	back to summary
public int getSize() Implements org.apache.poi.poifs.filesystem.DocumentEntry.getSize. get the zize of the document, in bytes Returns:int size in bytes

getSize

back to summary

public int getSize()

Implements org.apache.poi.poifs.filesystem.DocumentEntry.getSize.

get the zize of the document, in bytes

Returns:int: size in bytes

getViewableArray	back to summary
public Object[] getViewableArray() Implements org.apache.poi.poifs.dev.POIFSViewable.getViewableArray. Get an array of objects, some of which may implement POIFSViewable Returns:Object[] an array of Object; may not be null, but may be empty

getViewableArray

back to summary

public Object[] getViewableArray()

Implements org.apache.poi.poifs.dev.POIFSViewable.getViewableArray.

Get an array of objects, some of which may implement POIFSViewable

Returns:Object[]: an array of Object; may not be null, but may be empty

getViewableIterator	back to summary
public Iterator<Object> getViewableIterator() Implements org.apache.poi.poifs.dev.POIFSViewable.getViewableIterator. Get an Iterator of objects, some of which may implement POIFSViewable Returns:Iterator<Object> an Iterator; may not be null, but may have an empty back end store

getViewableIterator

back to summary

public Iterator<Object> getViewableIterator()

Implements org.apache.poi.poifs.dev.POIFSViewable.getViewableIterator.

Get an Iterator of objects, some of which may implement POIFSViewable

Returns:Iterator<Object>: an Iterator; may not be null, but may have an empty back end store

isDeleteOK	back to summary
protected boolean isDeleteOK() Implements abstract org.apache.poi.poifs.filesystem.EntryNode.isDeleteOK. extensions use this method to verify internal rules regarding deletion of the underlying store. Returns:boolean true if it's ok to delete the underlying store, else false Annotations @Override

isDeleteOK

back to summary

protected boolean isDeleteOK()

Implements abstract org.apache.poi.poifs.filesystem.EntryNode.isDeleteOK.

extensions use this method to verify internal rules regarding deletion of the underlying store.

Returns:boolean

true if it's ok to delete the underlying store, else false

Annotations

@Override

isDocumentEntry	back to summary
public boolean isDocumentEntry() Overrides org.apache.poi.poifs.filesystem.EntryNode.isDocumentEntry. Implements org.apache.poi.poifs.filesystem.Entry.isDocumentEntry. is this a DocumentEntry? Returns:boolean true if the Entry is a DocumentEntry, else false Annotations @Override

isDocumentEntry

back to summary

public boolean isDocumentEntry()

Overrides org.apache.poi.poifs.filesystem.EntryNode.isDocumentEntry.

Implements org.apache.poi.poifs.filesystem.Entry.isDocumentEntry.

is this a DocumentEntry?

Returns:boolean

true if the Entry is a DocumentEntry, else false

Annotations

@Override

preferArray	back to summary
public boolean preferArray() Implements org.apache.poi.poifs.dev.POIFSViewable.preferArray. Give viewers a hint as to whether to call getViewableArray or getViewableIterator Returns:boolean true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator

preferArray

back to summary

public boolean preferArray()

Implements org.apache.poi.poifs.dev.POIFSViewable.preferArray.

Give viewers a hint as to whether to call getViewableArray or getViewableIterator

Returns:boolean: true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator

public Class DocumentNode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail