CoreConfigurationBuilder (ehcache 3.11.1 API)

java.lang.Object
- org.ehcache.core.config.CoreConfigurationBuilder

All Implemented Interfaces:: Builder<Configuration>, FluentConfigurationBuilder

Direct Known Subclasses:: ConfigurationBuilder

public class CoreConfigurationBuilder<B extends CoreConfigurationBuilder<B>>
extends java.lang.Object
implements FluentConfigurationBuilder<B>

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Configuration`	`build()` Builds an instance.
`CacheConfiguration<?,?>`	`getCache(java.lang.String alias)` Return the cache configuration for the given alias.
`java.lang.ClassLoader`	`getClassLoader()` Return the configured classloader instance.
`<C extends ServiceCreationConfiguration<?,?>> java.util.Collection<C>`	`getServices(java.lang.Class<C> configurationType)` Return the service creation configurations of the given type.
`protected B`	`newBuilderWith(java.lang.ClassLoader classLoader)`
`protected B`	`newBuilderWith(java.util.Collection<ServiceCreationConfiguration<?,?>> serviceConfigurations)`
`protected B`	`newBuilderWith(java.util.Map<java.lang.String,CacheConfiguration<?,?>> caches)`
`protected B`	`newBuilderWith(ResourcePools sharedResourcePools)`
`protected static CoreConfigurationBuilder<?>`	`newConfigurationBuilder(Configuration seed)` Create a configuration builder seeded from the given configuration.
`B`	`updateCache(java.lang.String alias, java.util.function.UnaryOperator<FluentCacheConfigurationBuilder<?,?,?>> update)` Updates the configuration of the identified cache.
`B`	`updateCaches(java.util.function.UnaryOperator<FluentCacheConfigurationBuilder<?,?,?>> update)` Updates the configuration of the all caches.
`<R,C extends ServiceCreationConfiguration<?,R>> B`	`updateServices(java.lang.Class<C> clazz, java.util.function.UnaryOperator<R> update)` Updates all service creation configurations of the given type.
`B`	`updateSharedResources(java.util.function.UnaryOperator<ResourcePools> update)` Updates the configured shared resource pools.
`B`	`withCache(java.lang.String alias, CacheConfiguration<?,?> config)` Adds the given cache to this configuration.
`B`	`withClassLoader(java.lang.ClassLoader classLoader)` Sets the given class loader as the cache manager classloader
`B`	`withDefaultClassLoader()` Removes any provided class loader returning to default behavior
`B`	`withoutCache(java.lang.String alias)` Removes the given cache from this configuration.
`<C extends ServiceCreationConfiguration<?,?>> B`	`withoutServices(java.lang.Class<C> clazz, java.util.function.Predicate<? super C> predicate)` Removes all service creation configurations of the given type that pass the predicate.
`B`	`withService(ServiceCreationConfiguration<?,?> config)` Adds a service creation configuration to this configuration.
`B`	`withSharedResources(ResourcePools sharedResourcePools)` Sets the shared `ResourcePools` in the returned builder.

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
 - CoreConfigurationBuilder
```
protected CoreConfigurationBuilder()
```
 - CoreConfigurationBuilder
```
protected CoreConfigurationBuilder(CoreConfigurationBuilder<?> builder,
 java.util.Map<java.lang.String,CacheConfiguration<?,?>> caches)
```
 - CoreConfigurationBuilder
```
protected CoreConfigurationBuilder(CoreConfigurationBuilder<?> builder,
 java.util.Collection<ServiceCreationConfiguration<?,?>> serviceConfigurations)
```
 - CoreConfigurationBuilder
```
protected CoreConfigurationBuilder(CoreConfigurationBuilder<?> builder,
 java.lang.ClassLoader classLoader)
```
 - CoreConfigurationBuilder
```
protected CoreConfigurationBuilder(CoreConfigurationBuilder<?> builder,
 ResourcePools resourcePools)
```
- Method Detail
 - newConfigurationBuilder
```
protected static CoreConfigurationBuilder<?> newConfigurationBuilder(Configuration seed)
```
 Create a configuration builder seeded from the given configuration.
 Calling build() on the returned builder will produce a functionally equivalent configuration to seed.
 
 Parameters:
 
 seed - configuration to duplicate
 
 Returns:
 
 a new configuration builder
 - build
```
public Configuration build()
```
 Description copied from interface: Builder
 
 Builds an instance.
 
 Specified by:
 
 build in interface Builder<Configuration>
 
 Returns:
 
 the newly built instance
 - getCache
```
public CacheConfiguration<?,?> getCache(java.lang.String alias)
```
 Description copied from interface: FluentConfigurationBuilder
 
 Return the cache configuration for the given alias.
 
 Specified by:
 
 getCache in interface FluentConfigurationBuilder>
 
 Parameters:
 
 alias - cache alias
 
 Returns:
 
 associated cache configuration
 
 See Also:
 
 FluentConfigurationBuilder.withCache(String, CacheConfiguration), FluentConfigurationBuilder.withCache(String, Builder), FluentConfigurationBuilder.updateCache(String, UnaryOperator), FluentConfigurationBuilder.withoutCache(String), FluentConfigurationBuilder.updateCaches(UnaryOperator)
 - withSharedResources
```
public B withSharedResources(ResourcePools sharedResourcePools)
```
 Description copied from interface: FluentConfigurationBuilder
 
 Sets the shared ResourcePools in the returned builder.
 Shared ResourcePools are optionally available to all caches within a cache manager.
 
 Specified by:
 
 withSharedResources in interface FluentConfigurationBuilder>
 
 Parameters:
 
 sharedResourcePools - the resource pools to use
 
 Returns:
 
 a new builder with the added shared resource pools
 
 See Also:
 
 (Builder), FluentConfigurationBuilder.updateSharedResources(UnaryOperator)
 - updateSharedResources
```
public B updateSharedResources(java.util.function.UnaryOperator<ResourcePools> update)
```
 Description copied from interface: FluentConfigurationBuilder
 
 Updates the configured shared resource pools.
 
 Specified by:
 
 updateSharedResources in interface FluentConfigurationBuilder>
 
 Parameters:
 
 update - resource pool update operation
 
 Returns:
 
 a new build with updated resource pools
 
 See Also:
 
 FluentConfigurationBuilder.withSharedResources(ResourcePools), FluentConfigurationBuilder.withSharedResources(Builder)
 - withCache
```
public B withCache(java.lang.String alias,
 CacheConfiguration<?,?> config)
```
 Description copied from interface: FluentConfigurationBuilder
 
 Adds the given cache to this configuration.
 This will overwrite any existing configuration for the cache with this alias.
 
 Specified by:
 
 withCache in interface FluentConfigurationBuilder>
 
 Parameters:
 
 alias - cache alias
 
 config - cache configuration
 
 Returns:
 
 an updated builder
 
 See Also:
 
 FluentConfigurationBuilder.getCache(String), FluentConfigurationBuilder.withCache(String, Builder), FluentConfigurationBuilder.updateCache(String, UnaryOperator), FluentConfigurationBuilder.withoutCache(String), FluentConfigurationBuilder.updateCaches(UnaryOperator)
 - withoutCache
```
public B withoutCache(java.lang.String alias)
```
 Description copied from interface: FluentConfigurationBuilder
 
 Removes the given cache from this configuration.
 
 Specified by:
 
 withoutCache in interface FluentConfigurationBuilder>
 
 Parameters:
 
 alias - cache alias
 
 Returns:
 
 an updated builder
 
 See Also:
 
 FluentConfigurationBuilder.getCache(String), FluentConfigurationBuilder.withCache(String, CacheConfiguration), FluentConfigurationBuilder.withCache(String, Builder), FluentConfigurationBuilder.updateCache(String, UnaryOperator), FluentConfigurationBuilder.updateCaches(UnaryOperator)
 - updateCache
```
public B updateCache(java.lang.String alias,
 java.util.function.UnaryOperator<FluentCacheConfigurationBuilder<?,?,?>> update)
```
 Description copied from interface: FluentConfigurationBuilder
 Updates the configuration of the identified cache.
 If a cache exists for the given alias then the following process is performed:
 1. The configuration is converted to a builder seeded with that configuration.
 2. The builder is then transformed using the update unary operator.
 3. A new configuration is generated by calling build() on the resultant builder.
 4. The new configuration is associated with the given alias.
 If there is no cache associated with the given alias then an IllegalStateException will be thrown.
 Specified by:
 
 updateCache in interface FluentConfigurationBuilder>
 
 Parameters:
 
 alias - cache alias
 
 update - configuration mutation function
 
 Returns:
 
 an updated builder
 
 See Also:
 
 FluentConfigurationBuilder.getCache(String), FluentConfigurationBuilder.withCache(String, CacheConfiguration), FluentConfigurationBuilder.withCache(String, Builder), FluentConfigurationBuilder.withoutCache(String), FluentConfigurationBuilder.updateCaches(UnaryOperator)
 - updateCaches
```
public B updateCaches(java.util.function.UnaryOperator<FluentCacheConfigurationBuilder<?,?,?>> update)
```
 Description copied from interface: FluentConfigurationBuilder
 Updates the configuration of the all caches.
 For every existing cache the following process is performed:
 1. The configuration is converted to a builder seeded with that configuration.
 2. The builder is then transformed using the update unary operator.
 3. A new configuration is generated by calling build() on the resultant builder.
 4. The new configuration is associated with the given alias.
 Specified by:
 
 updateCaches in interface FluentConfigurationBuilder>
 
 Parameters:
 
 update - configuration mutation function
 
 Returns:
 
 an updated builder
 
 See Also:
 
 FluentConfigurationBuilder.getCache(String), FluentConfigurationBuilder.withCache(String, CacheConfiguration), FluentConfigurationBuilder.withCache(String, Builder), FluentConfigurationBuilder.updateCache(String, UnaryOperator), FluentConfigurationBuilder.withoutCache(String)
 - getServices
```
public <C extends ServiceCreationConfiguration<?,?>> java.util.Collection<C> getServices(java.lang.Class<C> configurationType)
```
 Description copied from interface: FluentConfigurationBuilder
 
 Return the service creation configurations of the given type.
 
 Specified by:
 
 getServices in interface FluentConfigurationBuilder>
 
 Type Parameters:
 
 C - configuration type
 
 Parameters:
 
 configurationType - desired configuration type
 
 Returns:
 
 all services of this type
 
 See Also:
 
 FluentConfigurationBuilder.getService(Class), FluentConfigurationBuilder.withService(ServiceCreationConfiguration), FluentConfigurationBuilder.withService(Builder), FluentConfigurationBuilder.withoutServices(Class), FluentConfigurationBuilder.withoutServices(Class, Predicate), FluentConfigurationBuilder.updateServices(Class, UnaryOperator)
 - withService
```
public B withService(ServiceCreationConfiguration<?,?> config)
```
 Description copied from interface: FluentConfigurationBuilder
 Adds a service creation configuration to this configuration.
 This will remove any existing service creation configurations that are incompatible with the supplied one. This removal is equivalent to the following:
```
 configurations.removeIf(
 existing -> !config.compatibleWith(existing) || !existing.compatibleWith(config)
 );
```
 Specified by:
 
 withService in interface FluentConfigurationBuilder>
 
 Parameters:
 
 config - service creation configuration
 
 Returns:
 
 an updated builder
 
 See Also:
 
 ServiceCreationConfiguration.compatibleWith(ServiceCreationConfiguration), FluentConfigurationBuilder.getService(Class), FluentConfigurationBuilder.getServices(Class), FluentConfigurationBuilder.withService(Builder), FluentConfigurationBuilder.withoutServices(Class), FluentConfigurationBuilder.withoutServices(Class, Predicate), FluentConfigurationBuilder.updateServices(Class, UnaryOperator)
 - withoutServices
```
public <C extends ServiceCreationConfiguration<?,?>> B withoutServices(java.lang.Class<C> clazz,
 java.util.function.Predicate<? super C> predicate)
```
 Description copied from interface: FluentConfigurationBuilder
 
 Removes all service creation configurations of the given type that pass the predicate.
 
 Specified by:
 
 withoutServices in interface FluentConfigurationBuilder>
 
 Type Parameters:
 
 C - configuration type
 
 Parameters:
 
 clazz - service configuration type
 
 predicate - predicate controlling removal
 
 Returns:
 
 an updated builder
 
 See Also:
 
 FluentConfigurationBuilder.getService(Class), FluentConfigurationBuilder.getServices(Class), FluentConfigurationBuilder.withService(ServiceCreationConfiguration), FluentConfigurationBuilder.withService(Builder), FluentConfigurationBuilder.withoutServices(Class), FluentConfigurationBuilder.updateServices(Class, UnaryOperator)
 - updateServices
```
public <R,C extends ServiceCreationConfiguration<?,R>> B updateServices(java.lang.Class<C> clazz,
 java.util.function.UnaryOperator<R> update)
```
 Description copied from interface: FluentConfigurationBuilder
 Updates all service creation configurations of the given type.
 For each existing service creation configuration instance that is assignment compatible with clazz the following process is performed:
 1. The configuration is converted to its detached representations using the ServiceCreationConfiguration.derive() method.
 2. The detached representation is transformed using the update unary operator.
 3. A new configuration is generated by passing the transformed detached representation to the existing configurations ServiceCreationConfiguration.build(Object) method.
 4. The new configuration is added to the builders service configuration set.
 If there are no service creation configurations assignment compatible with clazz then an IllegalStateException will be thrown.
 Specified by:
 
 updateServices in interface FluentConfigurationBuilder>
 
 Type Parameters:
 
 R - configuration detached representation type
 
 C - service configuration type
 
 Parameters:
 
 clazz - service creation configuration type
 
 update - configuration mutation function
 
 Returns:
 
 an updated builder
 
 See Also:
 
 FluentConfigurationBuilder.getService(Class), FluentConfigurationBuilder.getServices(Class), FluentConfigurationBuilder.withService(ServiceCreationConfiguration), FluentConfigurationBuilder.withService(Builder), FluentConfigurationBuilder.withoutServices(Class), FluentConfigurationBuilder.withoutServices(Class, Predicate)
 - getClassLoader
```
public java.lang.ClassLoader getClassLoader()
```
 Description copied from interface: FluentConfigurationBuilder
 
 Return the configured classloader instance.
 
 Specified by:
 
 getClassLoader in interface FluentConfigurationBuilder>
 
 Returns:
 
 configured classloader
 
 See Also:
 
 FluentConfigurationBuilder.withClassLoader(ClassLoader), FluentConfigurationBuilder.withDefaultClassLoader()
 - withClassLoader
```
public B withClassLoader(java.lang.ClassLoader classLoader)
```
 Description copied from interface: FluentConfigurationBuilder
 
 Sets the given class loader as the cache manager classloader
 
 Specified by:
 
 withClassLoader in interface FluentConfigurationBuilder>
 
 Parameters:
 
 classLoader - cache manager classloader
 
 Returns:
 
 an updated builder
 
 See Also:
 
 FluentConfigurationBuilder.getClassLoader(), FluentConfigurationBuilder.withDefaultClassLoader()
 - withDefaultClassLoader
```
public B withDefaultClassLoader()
```
 Description copied from interface: FluentConfigurationBuilder
 
 Removes any provided class loader returning to default behavior
 
 Specified by:
 
 withDefaultClassLoader in interface FluentConfigurationBuilder>
 
 Returns:
 
 an updated builder
 
 See Also:
 
 FluentConfigurationBuilder.getClassLoader(), FluentConfigurationBuilder.withClassLoader(ClassLoader)
 - newBuilderWith
```
protected B newBuilderWith(java.util.Map<java.lang.String,CacheConfiguration<?,?>> caches)
```
 - newBuilderWith
```
protected B newBuilderWith(java.util.Collection<ServiceCreationConfiguration<?,?>> serviceConfigurations)
```
 - newBuilderWith
```
protected B newBuilderWith(java.lang.ClassLoader classLoader)
```
 - newBuilderWith
```
protected B newBuilderWith(ResourcePools sharedResourcePools)
```

Class CoreConfigurationBuilder<B extends CoreConfigurationBuilder<B>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.ehcache.config.FluentConfigurationBuilder

Constructor Detail

CoreConfigurationBuilder

CoreConfigurationBuilder

CoreConfigurationBuilder

CoreConfigurationBuilder

CoreConfigurationBuilder

Method Detail

newConfigurationBuilder

build

getCache

withSharedResources

updateSharedResources

withCache

withoutCache

updateCache

updateCaches

getServices

withService

withoutServices

updateServices

getClassLoader

withClassLoader

withDefaultClassLoader

newBuilderWith

newBuilderWith

newBuilderWith

newBuilderWith