org.apache.poi

Class POIXMLProperties.CustomProperties

java.lang.Object

org.apache.poi.POIXMLProperties.CustomProperties

Enclosing class:

POIXMLProperties

public class POIXMLProperties.CustomProperties
extends Object

Custom document properties

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and 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	contains(String name) Check if a property with this name already exists in the collection of custom properties
org.openxmlformats.schemas.officeDocument.x2006.customProperties.CTProperties	getUnderlyingProperties()
protected int	nextPid() 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 Detail

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:

Constant Field Values

Method Detail

getUnderlyingProperties

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

addProperty

public void addProperty(String name,
               String value)

Add a new string property

Throws:

IllegalArgumentException - if a property with this name already exists

addProperty

public void addProperty(String name,
               double value)

Add a new double property

Throws:

IllegalArgumentException - if a property with this name already exists

addProperty

public void addProperty(String name,
               int value)

Add a new integer property

Throws:

IllegalArgumentException - if a property with this name already exists

addProperty

public void addProperty(String name,
               boolean value)

Add a new boolean property

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