Package org.ehcache.config.builders

Class ConfigurationBuilder

java.lang.Object
org.ehcache.core.config.CoreConfigurationBuilder<ConfigurationBuilder>
org.ehcache.config.builders.ConfigurationBuilder
All Implemented Interfaces:
org.ehcache.config.Builder<org.ehcache.config.Configuration>, org.ehcache.config.FluentConfigurationBuilder<ConfigurationBuilder>
public final class ConfigurationBuilder extends org.ehcache.core.config.CoreConfigurationBuilder<ConfigurationBuilder>
The ConfigurationBuilder enables building Configurations using a fluent style.

  • Constructor Details

    • ConfigurationBuilder

      protected ConfigurationBuilder()

    • ConfigurationBuilder

      protected ConfigurationBuilder(ConfigurationBuilder builder, Map<String,org.ehcache.config.CacheConfiguration<?,?>> caches)

    • ConfigurationBuilder

      protected ConfigurationBuilder(ConfigurationBuilder builder, Collection<org.ehcache.spi.service.ServiceCreationConfiguration<?,?>> serviceConfigurations)

    • ConfigurationBuilder

      protected ConfigurationBuilder(ConfigurationBuilder builder, ClassLoader classLoader)

    • ConfigurationBuilder

      protected ConfigurationBuilder(ConfigurationBuilder builder, org.ehcache.config.ResourcePools sharedResourcePools)

  • Method Details

    • newConfigurationBuilder

      public static ConfigurationBuilder newConfigurationBuilder()
      Create a new 'empty' configuration builder.
      Returns:
      a new empty configuration builder

    • newConfigurationBuilder

      public static ConfigurationBuilder newConfigurationBuilder(org.ehcache.config.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(String alias, org.ehcache.config.CacheConfiguration<?,?> config) throws 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:
      IllegalArgumentException

    • removeCache

      @Deprecated public ConfigurationBuilder removeCache(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(org.ehcache.spi.service.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(org.ehcache.spi.service.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(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(Map<String,org.ehcache.config.CacheConfiguration<?,?>> caches)
      Overrides:
      newBuilderWith in class org.ehcache.core.config.CoreConfigurationBuilder<ConfigurationBuilder>

    • newBuilderWith

      protected ConfigurationBuilder newBuilderWith(Collection<org.ehcache.spi.service.ServiceCreationConfiguration<?,?>> serviceConfigurations)
      Overrides:
      newBuilderWith in class org.ehcache.core.config.CoreConfigurationBuilder<ConfigurationBuilder>

    • newBuilderWith

      protected ConfigurationBuilder newBuilderWith(ClassLoader classLoader)
      Overrides:
      newBuilderWith in class org.ehcache.core.config.CoreConfigurationBuilder<ConfigurationBuilder>

    • newBuilderWith

      protected ConfigurationBuilder newBuilderWith(org.ehcache.config.ResourcePools sharedResourcePools)
      Overrides:
      newBuilderWith in class org.ehcache.core.config.CoreConfigurationBuilder<ConfigurationBuilder>