com.communote.server.core.property

Class PropertyCacheKey

java.lang.Object

com.communote.server.core.property.PropertyCacheKey

All Implemented Interfaces:

CacheKey

public class PropertyCacheKey
extends Object
implements CacheKey

Cache key to identify a property by group and key

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
PropertyCacheKey(PropertyType type, String keyGroup, String key) Cache key to identify a property by group and key

Method Summary

Modifier and Type	Method and Description
String	getCacheKeyString() String representation of the cache key which will be used for caching.
String	getKey()
String	getKeyGroup()
boolean	isUniquePerClient() Returns true if the cache key should be treated as client specific.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyCacheKey

public PropertyCacheKey(PropertyType type,
                        String keyGroup,
                        String key)

Cache key to identify a property by group and key

Parameters:

type - the type of the property

keyGroup - the group of the key of the property

key - the key of the property

Method Detail

getCacheKeyString

public String getCacheKeyString()

Description copied from interface: CacheKey

String representation of the cache key which will be used for caching.

Specified by:

getCacheKeyString in interface CacheKey

Returns:

the string representation

getKey

public String getKey()

Returns:

the key of the property

getKeyGroup

public String getKeyGroup()

Returns:

the group of the key of the property

isUniquePerClient

public boolean isUniquePerClient()

Description copied from interface: CacheKey

Returns true if the cache key should be treated as client specific. Using such a cache key will result in caching an element per client. A return value of false indicates that the data will be cached application wide.

Specified by:

isUniquePerClient in interface CacheKey

Returns:

whether the cache key should be treated as client specific