public interface

ContentPropertyManager

com.atlassian.confluence.core.ContentPropertyManager
Known Indirect Subclasses

Summary

Public Methods
String getStringProperty(ContentEntityObject entity, String key)
Get a string property associated with a content entity object, or null if that property is not set.
String getTextProperty(ContentEntityObject entity, String key)
Get a text property associated with a content entity object, or null if that property is not set.
void removeProperties(ContentEntityObject entity)
Remove all the properties associated with the content entity object.
void removeProperty(ContentEntityObject entity, String key)
Remove the property associated with the conetent entity object.
void setStringProperty(ContentEntityObject entity, String key, String value)
Associate a string property with a content entity object, or null if that property is not set.
void setTextProperty(ContentEntityObject entity, String key, String value)
Associate a text property with a content entity object, or null if that property is not set.

Public Methods

public String getStringProperty (ContentEntityObject entity, String key)

Get a string property associated with a content entity object, or null if that property is not set. String properties can not be longer than 255 characters

Parameters
entity the entity the property is associated with
key the key with which to look up the property
Returns
  • the property, or null if no such property exists

public String getTextProperty (ContentEntityObject entity, String key)

Get a text property associated with a content entity object, or null if that property is not set. Text properties can be longer than 255 characters, but I suspect anything over 4096 characters will break Oracle.

Parameters
entity the entity the property is associated with
key the key with which to look up the property
Returns
  • the property, or null if no such property exists

public void removeProperties (ContentEntityObject entity)

Remove all the properties associated with the content entity object.

Parameters
entity the entity the property is associated with

public void removeProperty (ContentEntityObject entity, String key)

Remove the property associated with the conetent entity object.

Parameters
entity the entity the property is associated with
key the key with which to look up the property

public void setStringProperty (ContentEntityObject entity, String key, String value)

Associate a string property with a content entity object, or null if that property is not set. String properties can not be longer than 255 characters. If a property is set longer than 255 characters, it will be truncated.

Parameters
entity the entity the property is associated with
key the key with which to look up the property
value the value to set

public void setTextProperty (ContentEntityObject entity, String key, String value)

Associate a text property with a content entity object, or null if that property is not set.

Parameters
entity the entity the property is associated with
key the key with which to look up the property
value the value to set