Class POIXMLProperties.CustomProperties

java.lang.Object
org.apache.poi.ooxml.POIXMLProperties.CustomProperties
Enclosing class:
POIXMLProperties

public static class POIXMLProperties.CustomProperties extends Object
Custom document properties
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Each custom property element contains an fmtid attribute with the same GUID value ({D5CDD505-2E9C-101B-9397-08002B2CF9AE}).
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addProperty(String name, boolean value)
    Add a new boolean property
    void
    addProperty(String name, double value)
    Add a new double property
    void
    addProperty(String name, int value)
    Add a new integer property
    void
    addProperty(String name, String value)
    Add a new string property
    boolean
    Check if a property with this name already exists in the collection of custom properties
    org.openxmlformats.schemas.officeDocument.x2006.customProperties.CTProperty
    Retrieve the custom property with this name, or null if none exists.
    org.openxmlformats.schemas.officeDocument.x2006.customProperties.CTProperties
     
    protected int
    Generate next id that uniquely relates a custom property

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • FORMAT_ID

      public static final String FORMAT_ID
      Each custom property element contains an fmtid attribute with the same GUID value ({D5CDD505-2E9C-101B-9397-08002B2CF9AE}).
      See Also:
  • Method Details

    • getUnderlyingProperties

      public org.openxmlformats.schemas.officeDocument.x2006.customProperties.CTProperties getUnderlyingProperties()
    • addProperty

      public void addProperty(String name, String value)
      Add a new string property
      Parameters:
      name - the property name
      value - the property value
      Throws:
      IllegalArgumentException - if a property with this name already exists
    • addProperty

      public void addProperty(String name, double value)
      Add a new double property
      Parameters:
      name - the property name
      value - the property value
      Throws:
      IllegalArgumentException - if a property with this name already exists
    • addProperty

      public void addProperty(String name, int value)
      Add a new integer property
      Parameters:
      name - the property name
      value - the property value
      Throws:
      IllegalArgumentException - if a property with this name already exists
    • addProperty

      public void addProperty(String name, boolean value)
      Add a new boolean property
      Parameters:
      name - the property name
      value - the property value
      Throws:
      IllegalArgumentException - if a property with this name already exists
    • nextPid

      protected int nextPid()
      Generate next id that uniquely relates a custom property
      Returns:
      next property id starting with 2
    • contains

      public boolean contains(String name)
      Check if a property with this name already exists in the collection of custom properties
      Parameters:
      name - the name to check
      Returns:
      whether a property with the given name exists in the custom properties
    • getProperty

      public org.openxmlformats.schemas.officeDocument.x2006.customProperties.CTProperty getProperty(String name)
      Retrieve the custom property with this name, or null if none exists. You will need to test the various isSetX methods to work out what the type of the property is, before fetching the appropriate value for it.
      Parameters:
      name - the name of the property to fetch
      Returns:
      the custom property with this name, or null if none exists