org.ehcache.config.builders

Class ConfigurationBuilder

java.lang.Object

org.ehcache.core.config.CoreConfigurationBuilder<ConfigurationBuilder>

org.ehcache.config.builders.ConfigurationBuilder

All Implemented Interfaces:

Builder<Configuration>, FluentConfigurationBuilder<ConfigurationBuilder>

public final class ConfigurationBuilder
extends CoreConfigurationBuilder<ConfigurationBuilder>

The ConfigurationBuilder enables building Configurations using a fluent style.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurationBuilder()
protected	ConfigurationBuilder(ConfigurationBuilder builder, java.lang.ClassLoader classLoader)
protected	ConfigurationBuilder(ConfigurationBuilder builder, java.util.Collection<ServiceCreationConfiguration<?,?>> serviceConfigurations)
protected	ConfigurationBuilder(ConfigurationBuilder builder, java.util.Map<java.lang.String,CacheConfiguration<?,?>> caches)
protected	ConfigurationBuilder(ConfigurationBuilder builder, ResourcePools sharedResourcePools)

Method Summary

Modifier and Type	Method and Description
ConfigurationBuilder	addCache(java.lang.String alias, CacheConfiguration<?,?> config) Deprecated. in favor of CoreConfigurationBuilder.withCache(String, CacheConfiguration)
ConfigurationBuilder	addService(ServiceCreationConfiguration<?,?> serviceConfiguration) Deprecated. in favor of CoreConfigurationBuilder.withService(ServiceCreationConfiguration)
boolean	containsCache(java.lang.String alias) Deprecated. in favor of CoreConfigurationBuilder.getCache(String)
protected ConfigurationBuilder	newBuilderWith(java.lang.ClassLoader classLoader)
protected ConfigurationBuilder	newBuilderWith(java.util.Collection<ServiceCreationConfiguration<?,?>> serviceConfigurations)
protected ConfigurationBuilder	newBuilderWith(java.util.Map<java.lang.String,CacheConfiguration<?,?>> caches)
protected ConfigurationBuilder	newBuilderWith(ResourcePools sharedResourcePools)
static ConfigurationBuilder	newConfigurationBuilder() Create a new 'empty' configuration builder.
static ConfigurationBuilder	newConfigurationBuilder(Configuration seed) Create a configuration builder seeded from the given configuration.
ConfigurationBuilder	removeCache(java.lang.String alias) Deprecated. in favor of CoreConfigurationBuilder.withoutCache(String)
ConfigurationBuilder	removeService(ServiceCreationConfiguration<?,?> serviceConfiguration) Deprecated. in favor of FluentConfigurationBuilder.withoutServices(Class) or CoreConfigurationBuilder.withoutServices(Class, Predicate)

Methods inherited from class org.ehcache.core.config.CoreConfigurationBuilder

build, getCache, getClassLoader, getServices, updateCache, updateCaches, updateServices, updateSharedResources, withCache, withClassLoader, withDefaultClassLoader, withoutCache, withoutServices, withService, withSharedResources

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ehcache.config.FluentConfigurationBuilder

getService, withCache, withoutServices, withService, withSharedResources

Constructor Detail

ConfigurationBuilder

protected ConfigurationBuilder()

ConfigurationBuilder

protected ConfigurationBuilder(ConfigurationBuilder builder,
                               java.util.Map<java.lang.String,CacheConfiguration<?,?>> caches)

ConfigurationBuilder

protected ConfigurationBuilder(ConfigurationBuilder builder,
                               java.util.Collection<ServiceCreationConfiguration<?,?>> serviceConfigurations)

ConfigurationBuilder

protected ConfigurationBuilder(ConfigurationBuilder builder,
                               java.lang.ClassLoader classLoader)

ConfigurationBuilder

protected ConfigurationBuilder(ConfigurationBuilder builder,
                               ResourcePools sharedResourcePools)

Method Detail

newConfigurationBuilder

public static ConfigurationBuilder newConfigurationBuilder()

Create a new 'empty' configuration builder.

Returns:

a new empty configuration builder

newConfigurationBuilder

public static ConfigurationBuilder newConfigurationBuilder(Configuration seed)

Create a configuration builder seeded from the given configuration.

Calling CoreConfigurationBuilder.build() on the returned builder will produce a functionally equivalent configuration to seed.

Parameters:

seed - configuration to duplicate

Returns:

a new configuration builder

addCache

@Deprecated
public ConfigurationBuilder addCache(java.lang.String alias,
                                                 CacheConfiguration<?,?> config)
                                          throws java.lang.IllegalArgumentException

Deprecated. in favor of CoreConfigurationBuilder.withCache(String, CacheConfiguration)

Add a cache configuration with the given alias.

If a cache with the given alias already exists then an IllegalArgumentException will be thrown.

Parameters:

alias - cache alias to be added

config - cache configuration

Returns:

an updated builder

Throws:

java.lang.IllegalArgumentException

removeCache

@Deprecated
public ConfigurationBuilder removeCache(java.lang.String alias)

Deprecated. in favor of CoreConfigurationBuilder.withoutCache(String)

Removes the cache with the given alias.

Parameters:

alias - cache alias to be removed

Returns:

an updated builder

addService

@Deprecated
public ConfigurationBuilder addService(ServiceCreationConfiguration<?,?> serviceConfiguration)

Deprecated. in favor of CoreConfigurationBuilder.withService(ServiceCreationConfiguration)

Adds the given service to this configuration.

If a a service creation configuration of the same concrete type is already present then an IllegalArgumentException will be thrown.

Parameters:

serviceConfiguration - service creation configuration

Returns:

an updated builder

removeService

@Deprecated
public ConfigurationBuilder removeService(ServiceCreationConfiguration<?,?> serviceConfiguration)

Deprecated. in favor of FluentConfigurationBuilder.withoutServices(Class) or CoreConfigurationBuilder.withoutServices(Class, Predicate)

Removes the given service configuration.

Parameters:

serviceConfiguration - service creation configuration

Returns:

an updated builder

containsCache

@Deprecated
public boolean containsCache(java.lang.String alias)

Deprecated. in favor of CoreConfigurationBuilder.getCache(String)

Returns true if a cache configuration is associated with the given alias.

Parameters:

alias - cache configuration alias

Returns:

true if the given alias is present

newBuilderWith

protected ConfigurationBuilder newBuilderWith(java.util.Map<java.lang.String,CacheConfiguration<?,?>> caches)

Overrides:

newBuilderWith in class CoreConfigurationBuilder<ConfigurationBuilder>

newBuilderWith

protected ConfigurationBuilder newBuilderWith(java.util.Collection<ServiceCreationConfiguration<?,?>> serviceConfigurations)

Overrides:

newBuilderWith in class CoreConfigurationBuilder<ConfigurationBuilder>

newBuilderWith

protected ConfigurationBuilder newBuilderWith(java.lang.ClassLoader classLoader)

Overrides:

newBuilderWith in class CoreConfigurationBuilder<ConfigurationBuilder>

newBuilderWith

protected ConfigurationBuilder newBuilderWith(ResourcePools sharedResourcePools)

Overrides:

newBuilderWith in class CoreConfigurationBuilder<ConfigurationBuilder>