com.atlassian.confluence.impl.propertyset

Class ReadThroughCachingContentPropertyManager

java.lang.Object

com.atlassian.confluence.impl.propertyset.ReadThroughCachingContentPropertyManager

All Implemented Interfaces:

ContentPropertyManager

public class ReadThroughCachingContentPropertyManager
extends Object
implements ContentPropertyManager

An implementation of ContentPropertyManager which caches the data from an underlying ConfluencePropertySetManager.

Since:

7.5

Method Summary

Modifier and Type	Method and Description
static ReadThroughCachingContentPropertyManager	create(ConfluencePropertySetManager propertySetManager, com.atlassian.cache.CacheFactory cacheFactory)
@Nullable String	getStringProperty(ContentEntityObject entity, String key) Get a string property associated with a content entity object, or null if that property is not set.
@Nullable 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 content entity object.
void	setStringProperty(ContentEntityObject entity, String key, @Nullable 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.
void	transferProperties(ContentEntityObject source, ContentEntityObject destination) Copies all properties associated with the source content entity object to the destination content entity object, and then removes all properties from the source content entity object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static ReadThroughCachingContentPropertyManager create(ConfluencePropertySetManager propertySetManager,
                                                              com.atlassian.cache.CacheFactory cacheFactory)

getStringProperty

public @Nullable String getStringProperty(ContentEntityObject entity,
                                          String key)

Description copied from interface: ContentPropertyManager

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

Specified by:

getStringProperty in interface ContentPropertyManager

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

setStringProperty

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

Description copied from interface: ContentPropertyManager

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.

Specified by:

setStringProperty in interface ContentPropertyManager

Parameters:

entity - the entity the property is associated with

key - the key with which to look up the property

value - the value to set

getTextProperty

public @Nullable String getTextProperty(ContentEntityObject entity,
                                        String key)

Description copied from interface: ContentPropertyManager

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.

Specified by:

getTextProperty in interface ContentPropertyManager

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

setTextProperty

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

Description copied from interface: ContentPropertyManager

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

Specified by:

setTextProperty in interface ContentPropertyManager

Parameters:

entity - the entity the property is associated with

key - the key with which to look up the property

value - the value to set

removeProperty

public void removeProperty(ContentEntityObject entity,
                           String key)

Description copied from interface: ContentPropertyManager

Remove the property associated with the content entity object.

Specified by:

removeProperty in interface ContentPropertyManager

Parameters:

entity - the entity the property is associated with

key - the key with which to look up the property

removeProperties

public void removeProperties(ContentEntityObject entity)

Description copied from interface: ContentPropertyManager

Remove all the properties associated with the content entity object.

Specified by:

removeProperties in interface ContentPropertyManager

Parameters:

entity - the entity the property is associated with

transferProperties

public void transferProperties(ContentEntityObject source,
                               ContentEntityObject destination)

Description copied from interface: ContentPropertyManager

Copies all properties associated with the source content entity object to the destination content entity object, and then removes all properties from the source content entity object.

Intended use is for any properties saved against a Draft to be transferred to the persisted content entity object.

Specified by:

transferProperties in interface ContentPropertyManager

Parameters:

source - the entity to copy and remove properties from

destination - the entity to copy properties to