com.communote.server.core.plugin

Class PluginPropertyCacheKey<T>

java.lang.Object

com.communote.server.core.plugin.PluginPropertyCacheKey<T>

Type Parameters:

T - The type of this property.

All Implemented Interfaces:

CacheKey

public class PluginPropertyCacheKey<T>
extends Object
implements CacheKey

Author:

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

Property Summary

Type	Property and Description
boolean	isApplication Gets the value of the property applicationProperty.

Constructor Summary

Constructors

Constructor and Description
PluginPropertyCacheKey(String symbolicName, boolean applicationProperty, boolean loadAllProperties) Constructor.
PluginPropertyCacheKey(String symbolicName, String propertyKey, boolean isApplicationProperty) Constructor.
PluginPropertyCacheKey(String symbolicName, String propertyKey, boolean isApplicationProperty, Class<T> type) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getCacheKeyString() String representation of the cache key which will be used for caching.
String	getPropertyKey()
String	getSymbolicName()
Class<T>	getType()
boolean	isApplicationProperty() Gets the value of the property applicationProperty.
boolean	isLoadAllProperties()
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

Property Detail

isApplication

public boolean isApplicationProperty

Gets the value of the property applicationProperty.

Constructor Detail

PluginPropertyCacheKey

public PluginPropertyCacheKey(String symbolicName,
                              boolean applicationProperty,
                              boolean loadAllProperties)

Constructor.

Parameters:

symbolicName - The symbolic name.

applicationProperty - True, if all application properties should be loaded.

loadAllProperties - If set, all properties will be loaded and not just a single one.

PluginPropertyCacheKey

public PluginPropertyCacheKey(String symbolicName,
                              String propertyKey,
                              boolean isApplicationProperty)

Constructor.

Parameters:

symbolicName - The symbolic name.

propertyKey - The properties key.

isApplicationProperty - True, if this is an application property.

PluginPropertyCacheKey

public PluginPropertyCacheKey(String symbolicName,
                              String propertyKey,
                              boolean isApplicationProperty,
                              Class<T> type)

Constructor.

Parameters:

symbolicName - The symbolic name.

propertyKey - The properties key.

isApplicationProperty - True, if this is an application property.

type - Class holding the propertys type.

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

getPropertyKey

public String getPropertyKey()

Returns:

the propertyKey

getSymbolicName

public String getSymbolicName()

Returns:

the symbolicName

getType

public Class<T> getType()

Returns:

the type

isApplicationProperty

public boolean isApplicationProperty()

Gets the value of the property applicationProperty.

isLoadAllProperties

public boolean isLoadAllProperties()

Returns:

the loadAllProperties

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