Class DocumentProperty

java.lang.Object
org.apache.poi.poifs.property.Property
org.apache.poi.poifs.property.DocumentProperty
All Implemented Interfaces:
POIFSViewable, Child

public class DocumentProperty extends Property
Trivial extension of Property for POIFSDocuments
  • Constructor Details

    • DocumentProperty

      public DocumentProperty(String name, int size)
      Constructor
      Parameters:
      name - POIFSDocument name
      size - POIFSDocument size
    • DocumentProperty

      protected DocumentProperty(int index, byte[] array, int offset)
      reader constructor
      Parameters:
      index - index number
      array - byte data
      offset - offset into byte data
  • Method Details

    • setDocument

      public void setDocument(POIFSDocument doc)
      set the POIFSDocument
      Parameters:
      doc - the associated POIFSDocument
    • getDocument

      public POIFSDocument getDocument()
      get the POIFSDocument
      Returns:
      the associated document
    • shouldUseSmallBlocks

      public boolean shouldUseSmallBlocks()
      give method more visibility
      Overrides:
      shouldUseSmallBlocks in class Property
      Returns:
      true if this property should use small blocks
    • isDirectory

      public boolean isDirectory()
      Specified by:
      isDirectory in class Property
      Returns:
      true if a directory type Property
    • preWrite

      protected void preWrite()
      Perform whatever activities need to be performed prior to writing
      Specified by:
      preWrite in class Property
    • updateSize

      public void updateSize(int size)
      Update the size of the property's data