Package org.docx4j.org.apache.poi.poifs.filesystem

Class DocumentNode

java.lang.Object
org.docx4j.org.apache.poi.poifs.filesystem.EntryNode
org.docx4j.org.apache.poi.poifs.filesystem.DocumentNode
All Implemented Interfaces:
POIFSViewable, DocumentEntry, Entry
public class DocumentNode
extends EntryNode
implements DocumentEntry, POIFSViewable
Simple implementation of DocumentEntry for OPOIFS

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getShortDescription()
    Provides 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 bytes
    java.lang.Object[] getViewableArray()
    Get an array of objects, some of which may implement POIFSViewable
    java.util.Iterator<java.lang.Object> getViewableIterator()
    Get an Iterator of objects, some of which may implement POIFSViewable
    protected boolean isDeleteOK()
    extensions use this method to verify internal rules regarding deletion of the underlying store.
    boolean isDocumentEntry()
    is this a DocumentEntry?
    boolean preferArray()
    Give viewers a hint as to whether to call getViewableArray or getViewableIterator

    Methods inherited from class org.docx4j.org.apache.poi.poifs.filesystem.EntryNode

    delete, getName, getParent, getProperty, isDirectoryEntry, isRoot, renameTo

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.docx4j.org.apache.poi.poifs.filesystem.Entry

    delete, getName, getParent, isDirectoryEntry, renameTo

  • Method Details

    • getSize

      public int getSize()
      get the zize of the document, in bytes
      Specified by:
      getSize in interface DocumentEntry
      Returns:
      size in bytes

    • isDocumentEntry

      public boolean isDocumentEntry()
      is this a DocumentEntry?
      Specified by:
      isDocumentEntry in interface Entry
      Overrides:
      isDocumentEntry in class EntryNode
      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 class EntryNode
      Returns:
      true if it's ok to delete the underlying store, else false

    • getViewableArray

      public java.lang.Object[] getViewableArray()
      Get an array of objects, some of which may implement POIFSViewable
      Specified by:
      getViewableArray in interface POIFSViewable
      Returns:
      an array of Object; may not be null, but may be empty

    • getViewableIterator

      public java.util.Iterator<java.lang.Object> getViewableIterator()
      Get an Iterator of objects, some of which may implement POIFSViewable
      Specified by:
      getViewableIterator in interface POIFSViewable
      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 interface POIFSViewable
      Returns:
      true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator

    • getShortDescription

      public java.lang.String getShortDescription()
      Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.
      Specified by:
      getShortDescription in interface POIFSViewable
      Returns:
      short description