de.smartics.properties.api.config.cache
Class CacheConfiguration

java.lang.Object
  de.smartics.properties.api.config.cache.CacheConfiguration

public final class CacheConfiguration
     
     

      
      extends 
      
      Object
     
     

The cache configuration information.

Field Summary

static String	CACHE_ID The identifier of the cache configuration that provides the properties.
static String	CACHE_NAME The key to the cache name.
static String	JNDI_NAME The key to the JNDI name of the cache container.

Constructor Summary

CacheConfiguration()
Default constructor.

CacheConfiguration(Properties properties)
Convenience constructor passing in a properties instance with properties to set by their keys.

Method Summary

String	getCacheId() Returns the unique identifier of the cache.
String	getCacheName() Returns the name of the cache to use within the cache container stored in the JNDI.
String	getJndiName() Returns the name to lookup the cache container instance in the JNDI.
boolean	isUnset() Checks whether or not the configuration has value.
void	setCacheId(String cacheId) Sets the unique identifier of the cache.
void	setCacheName(String cacheName) Sets the name of the cache to use within the cache container stored in the JNDI.
void	setJndiName(String jndiName) Sets the name to lookup the cache container instance in the JNDI.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_ID

public static final String CACHE_ID

The identifier of the cache configuration that provides the properties.

The value of this constant is "de.smartics.properties.cache.id".

Constant Field Value:

"de.smartics.properties.cache.id"

JNDI_NAME

public static final String JNDI_NAME

The key to the JNDI name of the cache container. The key is used to lookup values in the JNDI or in properties configuration files.

The value of this constant is "de.smartics.properties.cache.jndiName".

Constant Field Value:

"de.smartics.properties.cache.jndiName"

CACHE_NAME

public static final String CACHE_NAME

The key to the cache name. The key is used to lookup values in the JNDI or in properties configuration files.

The value of this constant is "de.smartics.properties.cache.cacheName".

Constant Field Value:

"de.smartics.properties.cache.cacheName"

Constructor Detail

CacheConfiguration

public CacheConfiguration()

Default constructor.

CacheConfiguration

public CacheConfiguration(Properties properties)

Convenience constructor passing in a properties instance with properties to set by their keys. Look at the keys defined as constants of this class for possible values.

Parameters:

properties - the properties to set.

Method Detail

getCacheId

public String getCacheId()

Returns the unique identifier of the cache.

Returns:

the unique identifier of the cache.

setCacheId

public void setCacheId(String cacheId)

Sets the unique identifier of the cache.

Parameters:

cacheId - the unique identifier of the cache.

getJndiName

public String getJndiName()

Returns the name to lookup the cache container instance in the JNDI.

Returns:

the name to lookup the cache container instance in the JNDI.

setJndiName

public void setJndiName(String jndiName)

Sets the name to lookup the cache container instance in the JNDI.

Parameters:

jndiName - the name to lookup container the cache instance in the JNDI.

getCacheName

public String getCacheName()

Returns the name of the cache to use within the cache container stored in the JNDI.

Returns:

the name of the cache to use within the cache container stored in the JNDI.

setCacheName

public void setCacheName(String cacheName)

Sets the name of the cache to use within the cache container stored in the JNDI.

Parameters:

cacheName - the name of the cache to use within the cache container stored in the JNDI.

isUnset

public boolean isUnset()

Checks whether or not the configuration has value.

Returns:

true if the configuration is unset, false otherwise.

toString

public String toString()

Overrides:

toString in class Object