org.ehcache.core.config

Class DefaultConfiguration

java.lang.Object

org.ehcache.core.config.DefaultConfiguration

All Implemented Interfaces:

org.ehcache.config.Configuration, org.ehcache.core.HumanReadable

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

Base implementation of Configuration.

Constructor Summary

Constructors

Constructor and Description
DefaultConfiguration(java.lang.ClassLoader classLoader, org.ehcache.spi.service.ServiceCreationConfiguration<?,?>... services) Creates a new configuration with the specified class loader.
DefaultConfiguration(org.ehcache.config.Configuration cfg) Copy constructor
DefaultConfiguration(java.util.Map<java.lang.String,org.ehcache.config.CacheConfiguration<?,?>> caches, java.lang.ClassLoader classLoader, org.ehcache.config.ResourcePools sharedResourcePools, org.ehcache.spi.service.ServiceCreationConfiguration<?,?>... services)
DefaultConfiguration(java.util.Map<java.lang.String,org.ehcache.config.CacheConfiguration<?,?>> caches, java.lang.ClassLoader classLoader, org.ehcache.spi.service.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, org.ehcache.config.CacheConfiguration<?,?> config) Adds a CacheConfiguration tied to the provided alias.
org.ehcache.config.FluentConfigurationBuilder<?>	derive()
java.util.Map<java.lang.String,org.ehcache.config.CacheConfiguration<?,?>>	getCacheConfigurations()
java.lang.ClassLoader	getClassLoader()
java.util.Collection<org.ehcache.spi.service.ServiceCreationConfiguration<?,?>>	getServiceCreationConfigurations()
org.ehcache.config.ResourcePools	getSharedResourcePools()
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, org.ehcache.config.CacheConfiguration<K,V> config, org.ehcache.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(org.ehcache.config.Configuration cfg)

Copy constructor

Parameters:

cfg - the configuration to copy

DefaultConfiguration

public DefaultConfiguration(java.lang.ClassLoader classLoader,
                            org.ehcache.spi.service.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,org.ehcache.config.CacheConfiguration<?,?>> caches,
                            java.lang.ClassLoader classLoader,
                            org.ehcache.spi.service.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

DefaultConfiguration

public DefaultConfiguration(java.util.Map<java.lang.String,org.ehcache.config.CacheConfiguration<?,?>> caches,
                            java.lang.ClassLoader classLoader,
                            org.ehcache.config.ResourcePools sharedResourcePools,
                            org.ehcache.spi.service.ServiceCreationConfiguration<?,?>... services)

Method Detail

getCacheConfigurations

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

Specified by:

getCacheConfigurations in interface org.ehcache.config.Configuration

getSharedResourcePools

public org.ehcache.config.ResourcePools getSharedResourcePools()

Specified by:

getSharedResourcePools in interface org.ehcache.config.Configuration

getServiceCreationConfigurations

public java.util.Collection<org.ehcache.spi.service.ServiceCreationConfiguration<?,?>> getServiceCreationConfigurations()

Specified by:

getServiceCreationConfigurations in interface org.ehcache.config.Configuration

getClassLoader

public java.lang.ClassLoader getClassLoader()

Specified by:

getClassLoader in interface org.ehcache.config.Configuration

derive

public org.ehcache.config.FluentConfigurationBuilder<?> derive()

Specified by:

derive in interface org.ehcache.config.Configuration

addCacheConfiguration

public void addCacheConfiguration(java.lang.String alias,
                                  org.ehcache.config.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,
                                            org.ehcache.config.CacheConfiguration<K,V> config,
                                            org.ehcache.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