Package org.apache.poi.ooxml
Class POIXMLProperties.CustomProperties
java.lang.Object
org.apache.poi.ooxml.POIXMLProperties.CustomProperties
- Enclosing class:
- POIXMLProperties
Custom document properties
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addProperty
(String name, boolean value) Add a new boolean propertyvoid
addProperty
(String name, double value) Add a new double propertyvoid
addProperty
(String name, int value) Add a new integer propertyvoid
addProperty
(String name, String value) Add a new string propertyboolean
Check if a property with this name already exists in the collection of custom propertiesorg.openxmlformats.schemas.officeDocument.x2006.customProperties.CTProperty
getProperty
(String name) Retrieve the custom property with this name, or null if none exists.org.openxmlformats.schemas.officeDocument.x2006.customProperties.CTProperties
protected int
nextPid()
Generate next id that uniquely relates a custom property
-
Field Details
-
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
Add a new string property- Parameters:
name
- the property namevalue
- the property value- Throws:
IllegalArgumentException
- if a property with this name already exists
-
addProperty
Add a new double property- Parameters:
name
- the property namevalue
- the property value- Throws:
IllegalArgumentException
- if a property with this name already exists
-
addProperty
Add a new integer property- Parameters:
name
- the property namevalue
- the property value- Throws:
IllegalArgumentException
- if a property with this name already exists
-
addProperty
Add a new boolean property- Parameters:
name
- the property namevalue
- 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
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
-