org.ehcache.core.config

Class DefaultConfiguration

java.lang.Object

org.ehcache.core.config.DefaultConfiguration

All Implemented Interfaces:

Configuration, org.ehcache.core.HumanReadable

public final class DefaultConfiguration
extends java.lang.Object
implements Configuration, org.ehcache.core.HumanReadable

Base implementation of Configuration.

Constructor Summary

Constructors

Constructor and Description
DefaultConfiguration(java.lang.ClassLoader classLoader, ServiceCreationConfiguration<?,?>... services) Creates a new configuration with the specified class loader.
DefaultConfiguration(Configuration cfg) Copy constructor
DefaultConfiguration(java.util.Map<java.lang.String,CacheConfiguration<?,?>> caches, java.lang.ClassLoader classLoader, ServiceCreationConfiguration<?,?>... services) Creates a new configuration with the specified cache configurations, class loader and service configurations.

Method Summary

Modifier and Type	Method and Description
void	addCacheConfiguration(java.lang.String alias, CacheConfiguration<?,?> config) Adds a CacheConfiguration tied to the provided alias.
FluentConfigurationBuilder<?>	derive() Creates a builder seeded with this configuration.
java.util.Map<java.lang.String,CacheConfiguration<?,?>>	getCacheConfigurations() Mapping of aliases to CacheConfigurations, used to configure the Caches managed by the CacheManager.
java.lang.ClassLoader	getClassLoader() The ClassLoader for the CacheManager.
java.util.Collection<ServiceCreationConfiguration<?,?>>	getServiceCreationConfigurations() ServiceCreationConfiguration initially used to bootstrap the CacheManager and its Caches.
java.lang.String	readableString()
void	removeCacheConfiguration(java.lang.String alias) Removes the CacheConfiguration tied to the provided alias.
<K,V> void	replaceCacheConfiguration(java.lang.String alias, CacheConfiguration<K,V> config, CacheRuntimeConfiguration<K,V> runtimeConfiguration) Replaces a CacheConfiguration with a CacheRuntimeConfiguration for the provided alias.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultConfiguration

public DefaultConfiguration(Configuration cfg)

Copy constructor

Parameters:

cfg - the configuration to copy

DefaultConfiguration

public DefaultConfiguration(java.lang.ClassLoader classLoader,
                            ServiceCreationConfiguration<?,?>... services)

Creates a new configuration with the specified class loader.

This means no cache configurations nor service configurations.

Parameters:

classLoader - the class loader to use

services - an array of service configurations

See Also:

addCacheConfiguration(String, CacheConfiguration)

DefaultConfiguration

public DefaultConfiguration(java.util.Map<java.lang.String,CacheConfiguration<?,?>> caches,
                            java.lang.ClassLoader classLoader,
                            ServiceCreationConfiguration<?,?>... services)

Creates a new configuration with the specified cache configurations, class loader and service configurations.

Parameters:

caches - a map from alias to cache configuration

classLoader - the class loader to use for user types

services - an array of service configurations

Method Detail

getCacheConfigurations

public java.util.Map<java.lang.String,CacheConfiguration<?,?>> getCacheConfigurations()

Mapping of aliases to CacheConfigurations, used to configure the Caches managed by the CacheManager.

The map must not be null but can be empty. It must be unmodifiable.

Specified by:

getCacheConfigurations in interface Configuration

Returns:

a map of aliases to cache configurations

getServiceCreationConfigurations

public java.util.Collection<ServiceCreationConfiguration<?,?>> getServiceCreationConfigurations()

ServiceCreationConfiguration initially used to bootstrap the CacheManager and its Caches.

The collection must not be null but can be empty. Also it must be unmodifiable.

Specified by:

getServiceCreationConfigurations in interface Configuration

Returns:

a collection of service creations configurations

getClassLoader

public java.lang.ClassLoader getClassLoader()

The ClassLoader for the CacheManager.

This ClassLoader will be used to instantiate cache manager level services and for Caches that do not have a specific ClassLoader.

The ClassLoader must not be null.

Specified by:

getClassLoader in interface Configuration

Returns:

the cache manager ClassLoader

derive

public FluentConfigurationBuilder<?> derive()

Description copied from interface: Configuration

Creates a builder seeded with this configuration.

The default implementation throws UnsupportedOperationException to indicate that configuration derivation is not supported.

Specified by:

derive in interface Configuration

Returns:

a configuration builder

See Also:

FluentConfigurationBuilder

addCacheConfiguration

public void addCacheConfiguration(java.lang.String alias,
                                  CacheConfiguration<?,?> config)

Adds a CacheConfiguration tied to the provided alias.

Parameters:

alias - the alias of the cache

config - the configuration of the cache

removeCacheConfiguration

public void removeCacheConfiguration(java.lang.String alias)

Removes the CacheConfiguration tied to the provided alias.

Parameters:

alias - the alias for which to remove configuration

replaceCacheConfiguration

public <K,V> void replaceCacheConfiguration(java.lang.String alias,
                                            CacheConfiguration<K,V> config,
                                            CacheRuntimeConfiguration<K,V> runtimeConfiguration)

Replaces a CacheConfiguration with a CacheRuntimeConfiguration for the provided alias.

Type Parameters:

K - the key type

V - the value type

Parameters:

alias - the alias of the cache

config - the existing configuration

runtimeConfiguration - the new configuration

Throws:

java.lang.IllegalStateException - if the replace fails

readableString

public java.lang.String readableString()

Specified by:

readableString in interface org.ehcache.core.HumanReadable