com.communote.server.core.common.caching

Class StringIdBasedCacheKey

java.lang.Object

com.communote.server.core.common.caching.StringIdBasedCacheKey

All Implemented Interfaces:

CacheKey

public class StringIdBasedCacheKey
extends Object
implements CacheKey

Cache key for identifying elements by a string identifier.

Author:

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

Constructor Summary

Constructors

Constructor and Description
StringIdBasedCacheKey(String id, String prefix) Creates a cache key encapsulating the ID.
StringIdBasedCacheKey(String id, String prefix, boolean uniquePerClient) Creates a cache key encapsulating the ID.

Method Summary

Modifier and Type	Method and Description
String	getCacheKeyString() String representation of the cache key which will be used for caching.
String	getId() The wrapped ID.
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

StringIdBasedCacheKey

public StringIdBasedCacheKey(String id,
                             String prefix)

Creates a cache key encapsulating the ID. The key will be used application wide (uniquePerClient = false).

Parameters:

id - the ID to be cached; must not be null

prefix - A prefix, which will be used for creating the cache key.

StringIdBasedCacheKey

public StringIdBasedCacheKey(String id,
                             String prefix,
                             boolean uniquePerClient)

Creates a cache key encapsulating the ID.

Parameters:

id - the ID to be cached; must not be null

prefix - A prefix, which will be used for creating the cache key.

uniquePerClient - See isUniquePerClient()

Method Detail

getCacheKeyString

public String getCacheKeyString()

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

Specified by:

getCacheKeyString in interface CacheKey

Returns:

the string representation

getId

public String getId()

The wrapped ID.

Returns:

the ID

isUniquePerClient

public boolean isUniquePerClient()

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