org.jboss.cache
Class DefaultCacheFactory<K,V>

java.lang.Object
  org.jboss.cache.DefaultCacheFactory<K,V>

All Implemented Interfaces:

CacheFactory<K,V>

public class DefaultCacheFactory<K,V>
extends java.lang.Object
implements CacheFactory<K,V>

Default (singleton) implementation of the CacheFactory interface. Use getInstance() to obtain an instance.

Author:

Manik Surtani (manik@jboss.org)

Constructor Summary

DefaultCacheFactory()

Method Summary

Cache<K,V>	createCache() Creates and starts a Cache instance using default configuration settings.
Cache<K,V>	createCache(boolean start) Creates and optionally starts a Cache instance using default configuration settings.
Cache<K,V>	createCache(Configuration configuration) This implementation clones the configuration passed in before using it.
Cache<K,V>	createCache(Configuration configuration, boolean start) This implementation clones the configuration passed in before using it.
Cache<K,V>	createCache(java.lang.String configFileName) Creates and starts a Cache instance.
Cache<K,V>	createCache(java.lang.String configFileName, boolean start) Creates Cache instance, and optionally starts it.
static <K,V> CacheFactory<K,V>	getInstance()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCacheFactory

public DefaultCacheFactory()

Method Detail

getInstance

public static <K,V> CacheFactory<K,V> getInstance()

Returns:

a singleton instance of this class.

createCache

public Cache<K,V> createCache()
                       throws ConfigurationException

Description copied from interface: CacheFactory

Creates and starts a Cache instance using default configuration settings. See Configuration for default values.

Specified by:

createCache in interface CacheFactory<K,V>

Returns:

a cache

Throws:

ConfigurationException - if there are problems with the default configuration

createCache

public Cache<K,V> createCache(boolean start)
                       throws ConfigurationException

Description copied from interface: CacheFactory

Creates and optionally starts a Cache instance using default configuration settings. See Configuration for default values.

Specified by:

createCache in interface CacheFactory<K,V>

Parameters:

start - if true, starts the cache

Returns:

a cache

Throws:

ConfigurationException - if there are problems with the default configuration

createCache

public Cache<K,V> createCache(java.lang.String configFileName)
                       throws ConfigurationException

Description copied from interface: CacheFactory

Creates and starts a Cache instance. The following are all valid calls:

    factory.createCache("myCacheService.xml"); // file is in class path
    factory.createCache("etc/myCacheService.xml"); // file is in etc/ relative to the directory you started the JVM
    factory.createCache("/home/jbosscache/myCacheService.xml"); // file is in the /home/jbosscache directory
 

Specified by:

createCache in interface CacheFactory<K,V>

Parameters:

configFileName - the named XML file should exist in the classpath or should be a fully qualified or relative (to your JVM working directory) path to a file on the local file system. Note that the classpath is checked first for the existence of this file.

Returns:

a running Cache instance

Throws:

ConfigurationException - if there are problems with the configuration

createCache

public Cache<K,V> createCache(java.lang.String configFileName,
                              boolean start)
                       throws ConfigurationException

Description copied from interface: CacheFactory

Creates Cache instance, and optionally starts it.

Specified by:

createCache in interface CacheFactory<K,V>

Parameters:

configFileName - the named XML file should exist in the classpath or should be a fully qualified or relative (to your JVM working directory) path to a file on the local file system. Note that the classpath is checked first for the existence of this file.

start - if true, the cache is started before returning.

Returns:

an optionally running Cache instance

Throws:

ConfigurationException - if there are problems with the configuration

See Also:

for examples on valid config file names.

createCache

public Cache<K,V> createCache(Configuration configuration)
                       throws ConfigurationException

This implementation clones the configuration passed in before using it.

Specified by:

createCache in interface CacheFactory<K,V>

Parameters:

configuration - to use

Returns:

a cache

Throws:

ConfigurationException - if there are problems with the cfg

createCache

public Cache<K,V> createCache(Configuration configuration,
                              boolean start)
                       throws ConfigurationException

This implementation clones the configuration passed in before using it.

Specified by:

createCache in interface CacheFactory<K,V>

Parameters:

configuration - to use

start - whether to start the cache

Returns:

a cache

Throws:

ConfigurationException - if there are problems with the cfg