Type Parameters:

K - cache key type

V - cache value type

B - builder sub-type

All Superinterfaces:

Builder<CacheConfiguration<K,V>>
```
public interface FluentCacheConfigurationBuilder<K,V,B extends FluentCacheConfigurationBuilder<K,V,?>>
extends Builder<CacheConfiguration<K,V>>
```
A fluent builder of CacheConfiguration instances.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`CacheConfiguration<K,V>`	`build()`	Builds a new `CacheConfiguration`.
`default <C extends ServiceConfiguration<?,?>> C`	`getService(java.lang.Class<C> configurationType)`	Return the unique service configuration of the given type.
`<C extends ServiceConfiguration<?,?>> java.util.Collection<C>`	`getServices(java.lang.Class<C> configurationType)`	Returns all the service configurations of the given type.
`B`	`updateResourcePools(java.util.function.UnaryOperator<ResourcePools> update)`	Updates the configured resource pools.
`<R,C extends ServiceConfiguration<?,R>> B`	`updateServices(java.lang.Class<C> clazz, java.util.function.UnaryOperator<R> update)`	Updates all service configurations of the given type.
`B`	`withClassLoader(java.lang.ClassLoader classLoader)`	Sets the `ClassLoader` in the returned builder.
`B`	`withDefaultClassLoader()`	Removes any previously installed custom class loader
`B`	`withDefaultKeySerializer()`	Removes any explicitly configured `Serializer` for cache keys.
`B`	`withDefaultResilienceStrategy()`	Restores configuration of the implementations default resilience strategy.
`B`	`withDefaultValueSerializer()`	Removes any explicitly configured `Serializer` for cache values.
`B`	`withEvictionAdvisor(EvictionAdvisor<? super K,? super V> evictionAdvisor)`	Sets the `EvictionAdvisor` in the returned builder.
`B`	`withExpiry(ExpiryPolicy<? super K,? super V> expiry)`	Sets the `ExpiryPolicy` configuration in the returned builder.
`B`	`withKeyCopier(java.lang.Class<? extends Copier<K>> keyCopierClass)`	Adds by-value semantics using the provided `Copier` class for the key on heap.
`B`	`withKeyCopier(Copier<K> keyCopier)`	Adds by-value semantics using the provided `Copier` for the key on heap.
`B`	`withKeySerializer(java.lang.Class<? extends Serializer<K>> keySerializerClass)`	Sets the `Serializer` class for cache keys in the returned builder.
`B`	`withKeySerializer(Serializer<K> keySerializer)`	Sets the `Serializer` for cache keys in the returned builder.
`B`	`withKeySerializingCopier()`	Adds by-value semantics using the cache key serializer for the key on heap.
`B`	`withLoaderWriter(java.lang.Class<CacheLoaderWriter<K,V>> loaderWriterClass, java.lang.Object... arguments)`	Sets the `CacheLoaderWriter` (using a class and constructor arguments) in the returned builder.
`B`	`withLoaderWriter(CacheLoaderWriter<K,V> loaderWriter)`	Sets the `CacheLoaderWriter` in the returned builder.
`B`	`withoutKeyCopier()`	Removes any configured `Copier` for keys on heap.
`B`	`withoutLoaderWriter()`	Removes any configured loader-writer.
`default B`	`withoutServices(java.lang.Class<? extends ServiceConfiguration<?,?>> clazz)`	Removes all service configurations of the given type from this configuration.
`<C extends ServiceConfiguration<?,?>> B`	`withoutServices(java.lang.Class<C> clazz, java.util.function.Predicate<? super C> predicate)`	Removes all service configurations of the given type that pass the predicate.
`B`	`withoutValueCopier()`	Removes any configured `Copier` for values on heap.
`B`	`withResilienceStrategy(java.lang.Class<? extends ResilienceStrategy> resilienceStrategyClass, java.lang.Object... arguments)`	Sets the `ResilienceStrategy` (using a class and constructor arguments) in the returned builder.
`B`	`withResilienceStrategy(ResilienceStrategy<K,V> resilienceStrategy)`	Sets the `ResilienceStrategy` in the returned builder.
`default B`	`withResourcePools(Builder<? extends ResourcePools> builder)`	Convenience method to set the `ResourcePools` through a `Builder`.
`B`	`withResourcePools(ResourcePools resourcePools)`	Sets the `ResourcePools` in the returned builder.
`default B`	`withService(Builder<? extends ServiceConfiguration<?,?>> builder)`	Adds a service configuration built by the given builder to this configuration.
`B`	`withService(ServiceConfiguration<?,?> config)`	Adds a service configuration to this configuration.
`B`	`withValueCopier(java.lang.Class<? extends Copier<V>> valueCopierClass)`	Adds by-value semantics using the provided `Copier` class for the value on heap.
`B`	`withValueCopier(Copier<V> valueCopier)`	Adds by-value semantics using the provided `Copier` for the value on heap.
`B`	`withValueSerializer(java.lang.Class<? extends Serializer<V>> valueSerializerClass)`	Sets the `Serializer` class for cache values in the returned builder.
`B`	`withValueSerializer(Serializer<V> valueSerializer)`	Sets the `Serializer` for cache values in the returned builder.
`B`	`withValueSerializingCopier()`	Adds by-value semantics using the cache value serializer for the value on heap.

- Method Detail
  - build
```
CacheConfiguration<K,V> build()
```
    Builds a new CacheConfiguration.
    
    Specified by:
    
    build in interface Builder<K>
    
    Returns:
    
    a new CacheConfiguration
  - getService
```
default <C extends ServiceConfiguration<?,?>> C getService(java.lang.Class<C> configurationType)
                                                          throws java.lang.IllegalArgumentException
```
    Return the unique service configuration of the given type.
    If there are multiple configuration instances of this type (or subtypes) then an IllegalArgumentException will be thrown.
    
    Type Parameters:
    
    C - configuration type
    
    Parameters:
    
    configurationType - desired configuration type
    
    Returns:
    
    the service configuration of the given type; @{code null} if there is no service configuration of the given type
    
    Throws:
    
    java.lang.IllegalArgumentException - if there are multiple instances of this type
    
    See Also:
    
    getServices(Class), withService(ServiceConfiguration), withService(Builder), withoutServices(Class), withoutServices(Class, Predicate), updateServices(Class, UnaryOperator)
  - getServices
```
<C extends ServiceConfiguration<?,?>> java.util.Collection<C> getServices(java.lang.Class<C> configurationType)
```
    Returns all the service configurations of the given type.
    
    Type Parameters:
    
    C - configuration type
    
    Parameters:
    
    configurationType - desired configuration type
    
    Returns:
    
    all services of this type
    
    See Also:
    
    getService(Class), withService(ServiceConfiguration), withService(Builder), withoutServices(Class), withoutServices(Class, Predicate), updateServices(Class, UnaryOperator)
  - withService
```
B withService(ServiceConfiguration<?,?> config)
```
    Adds a service configuration to this configuration.
    This will remove any existing service configurations that are incompatible with the supplied one. This removal is equivalent to the following:
    configurations.removeIf( existing -> !config.compatibleWith(existing) || !existing.compatibleWith(config) );
    Parameters:
    
    config - service configuration
    
    Returns:
    
    an updated builder
    
    See Also:
    
    ServiceConfiguration.compatibleWith(ServiceConfiguration), getService(Class), getServices(Class), withService(Builder), withoutServices(Class), withoutServices(Class, Predicate), updateServices(Class, UnaryOperator)
  - withService
```
default B withService(Builder<? extends ServiceConfiguration<?,?>> builder)
```
    Adds a service configuration built by the given builder to this configuration.
    This will remove any existing configurations that are incompatible with the configuration returned by builder.build().
    
    Parameters:
    
    builder - service configuration builder
    
    Returns:
    
    an updated builder
    
    See Also:
    
    withService(ServiceConfiguration), getService(Class), getServices(Class), withService(ServiceConfiguration), withoutServices(Class), withoutServices(Class, Predicate), updateServices(Class, UnaryOperator)
  - withoutServices
```
default B withoutServices(java.lang.Class<? extends ServiceConfiguration<?,?>> clazz)
```
    Removes all service configurations of the given type from this configuration.
    
    Parameters:
    
    clazz - service configuration type
    
    Returns:
    
    an updated builder
    
    See Also:
    
    getService(Class), getServices(Class), withService(ServiceConfiguration), withService(Builder), withoutServices(Class, Predicate), updateServices(Class, UnaryOperator)
  - withoutServices
```
<C extends ServiceConfiguration<?,?>> B withoutServices(java.lang.Class<C> clazz,
                                                              java.util.function.Predicate<? super C> predicate)
```
    Removes all service configurations of the given type that pass the predicate.
    
    Type Parameters:
    
    C - configuration type
    
    Parameters:
    
    clazz - service configuration type
    
    predicate - predicate controlling removal
    
    Returns:
    
    an updated builder
    
    See Also:
    
    getService(Class), getServices(Class), withService(ServiceConfiguration), withService(Builder), withoutServices(Class), updateServices(Class, UnaryOperator)
  - updateServices
```
<R,C extends ServiceConfiguration<?,R>> B updateServices(java.lang.Class<C> clazz,
                                                                     java.util.function.UnaryOperator<R> update)
                                                              throws java.lang.IllegalStateException
```
    Updates all service configurations of the given type.
    For each existing service creation configuration instance that is assignment compatible with clazz the following process is performed:
    
    The configuration is converted to its detached representations using the ServiceConfiguration.derive() method.
    
    The detached representation is transformed using the update unary operator.
    
    A new configuration is generated by passing the transformed detached representation to the existing configurations ServiceConfiguration.build(Object) method.
    
    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.
    Type Parameters:
    
    R - configuration detached representation type
    
    C - service configuration type
    
    Parameters:
    
    clazz - service configuration concrete type
    
    update - configuration mutation function
    
    Returns:
    
    an updated builder
    
    Throws:
    
    java.lang.IllegalStateException - if no matching service configurations exist
    
    See Also:
    
    getService(Class), getServices(Class), withService(ServiceConfiguration), withService(Builder), withoutServices(Class), withoutServices(Class, Predicate)
  - withEvictionAdvisor
```
B withEvictionAdvisor(EvictionAdvisor<? super K,? super V> evictionAdvisor)
```
    Sets the EvictionAdvisor in the returned builder.
    
    Parameters:
    
    evictionAdvisor - the eviction advisor to be used
    
    Returns:
    
    a new builder with the added eviction advisor
    
    See Also:
    
    Eviction.NO_ADVICE
  - withClassLoader
```
B withClassLoader(java.lang.ClassLoader classLoader)
```
    Sets the ClassLoader in the returned builder.
    The ClassLoader will be used for resolving all non Ehcache types.
    
    Parameters:
    
    classLoader - the class loader to use
    
    Returns:
    
    a new builder with the added class loader
    
    See Also:
    
    withDefaultClassLoader()
  - withDefaultClassLoader
```
B withDefaultClassLoader()
```
    Removes any previously installed custom class loader
    
    Returns:
    
    a new build using the default class loader
    
    See Also:
    
    withClassLoader(ClassLoader)
  - withResourcePools
```
B withResourcePools(ResourcePools resourcePools)
```
    Sets the ResourcePools in the returned builder.
    ResourcePools is what determines the tiering of a cache.
    
    Parameters:
    
    resourcePools - the resource pools to use
    
    Returns:
    
    a new builder with the added resource pools
    
    See Also:
    
    withResourcePools(Builder), updateResourcePools(UnaryOperator)
  - withResourcePools
```
default B withResourcePools(Builder<? extends ResourcePools> builder)
```
    Convenience method to set the ResourcePools through a Builder.
    
    Parameters:
    
    builder - the builder providing the resource pool
    
    Returns:
    
    a new builder with the added resource pools
    
    See Also:
    
    withResourcePools(ResourcePools), updateResourcePools(UnaryOperator)
  - updateResourcePools
```
B updateResourcePools(java.util.function.UnaryOperator<ResourcePools> update)
```
    Updates the configured resource pools.
    
    Parameters:
    
    update - resource pool update operation
    
    Returns:
    
    a new build with updated resource pools
    
    See Also:
    
    withResourcePools(ResourcePools), withResourcePools(Builder)
  - withExpiry
```
B withExpiry(ExpiryPolicy<? super K,? super V> expiry)
```
    Sets the ExpiryPolicy configuration in the returned builder.
    ExpiryPolicy is what controls data freshness in a cache.
    
    Parameters:
    
    expiry - the expiry to use
    
    Returns:
    
    a new builder with the added expiry
    
    See Also:
    
    ExpiryPolicy.NO_EXPIRY
  - withLoaderWriter
```
B withLoaderWriter(CacheLoaderWriter<K,V> loaderWriter)
```
    Sets the CacheLoaderWriter in the returned builder.
    Configuration of a CacheLoaderWriter is what enables cache-through patterns.
    
    Parameters:
    
    loaderWriter - the loaderwriter to use
    
    Returns:
    
    a new builder with the added loaderwriter configuration
    
    See Also:
    
    withLoaderWriter(Class, Object...), withoutLoaderWriter()
  - withLoaderWriter
```
B withLoaderWriter(java.lang.Class<CacheLoaderWriter<K,V>> loaderWriterClass,
                   java.lang.Object... arguments)
```
    Sets the CacheLoaderWriter (using a class and constructor arguments) in the returned builder.
    Configuration of a CacheLoaderWriter is what enables cache-through patterns.
    
    Parameters:
    
    loaderWriterClass - the loaderwrite class
    
    arguments - optional constructor arguments
    
    Returns:
    
    a new builder with the added loaderwriter configuration
    
    See Also:
    
    withLoaderWriter(CacheLoaderWriter), withoutLoaderWriter()
  - withoutLoaderWriter
```
B withoutLoaderWriter()
```
    Removes any configured loader-writer.
    
    Returns:
    
    a new build with no configured loader-writer
    
    See Also:
    
    withLoaderWriter(CacheLoaderWriter), withLoaderWriter(Class, Object...)
  - withResilienceStrategy
```
B withResilienceStrategy(ResilienceStrategy<K,V> resilienceStrategy)
```
    Sets the ResilienceStrategy in the returned builder.
    
    Parameters:
    
    resilienceStrategy - the resilience strategy to use
    
    Returns:
    
    a new builder with the added resilience strategy configuration
    
    See Also:
    
    withResilienceStrategy(Class, Object...), withDefaultResilienceStrategy()
  - withResilienceStrategy
```
B withResilienceStrategy(java.lang.Class<? extends ResilienceStrategy> resilienceStrategyClass,
                         java.lang.Object... arguments)
```
    Sets the ResilienceStrategy (using a class and constructor arguments) in the returned builder.
    
    Parameters:
    
    resilienceStrategyClass - the resilience strategy class
    
    arguments - optional constructor arguments
    
    Returns:
    
    a new builder with the added resilience strategy configuration
    
    See Also:
    
    withResilienceStrategy(ResilienceStrategy), withDefaultResilienceStrategy()
  - withDefaultResilienceStrategy
```
B withDefaultResilienceStrategy()
```
    Restores configuration of the implementations default resilience strategy.
    
    Returns:
    
    a new builder using the default resilience strategy
    
    See Also:
    
    withResilienceStrategy(ResilienceStrategy), withResilienceStrategy(Class, Object...)
  - withKeySerializingCopier
```
B withKeySerializingCopier()
```
    Adds by-value semantics using the cache key serializer for the key on heap.
    Copiers are what enable control of by-reference / by-value semantics for on-heap tier.
    
    Returns:
    
    a new builder with the added key copier
    
    See Also:
    
    withKeyCopier(Copier), withKeyCopier(Class), withoutKeyCopier()
  - withValueSerializingCopier
```
B withValueSerializingCopier()
```
    Adds by-value semantics using the cache value serializer for the value on heap.
    Copiers are what enable control of by-reference / by-value semantics for on-heap tier.
    
    Returns:
    
    a new builder with the added value copier
    
    See Also:
    
    withValueCopier(Copier), withValueCopier(Class), withoutValueCopier()
  - withKeyCopier
```
B withKeyCopier(Copier<K> keyCopier)
```
    Adds by-value semantics using the provided Copier for the key on heap.
    Copiers are what enable control of by-reference / by-value semantics for on-heap tier.
    
    Parameters:
    
    keyCopier - the key copier to use
    
    Returns:
    
    a new builder with the added key copier
    
    See Also:
    
    withKeySerializingCopier(), withKeyCopier(Class), withoutKeyCopier()
  - withKeyCopier
```
B withKeyCopier(java.lang.Class<? extends Copier<K>> keyCopierClass)
```
    Adds by-value semantics using the provided Copier class for the key on heap.
    Copiers are what enable control of by-reference / by-value semantics for on-heap tier.
    
    Parameters:
    
    keyCopierClass - the key copier class to use
    
    Returns:
    
    a new builder with the added key copier
    
    See Also:
    
    withKeySerializingCopier(), withKeyCopier(Copier), withoutKeyCopier()
  - withoutKeyCopier
```
B withoutKeyCopier()
```
    Removes any configured Copier for keys on heap.
    
    Returns:
    
    a new builder without a key copier
    
    See Also:
    
    withKeySerializingCopier(), withKeyCopier(Copier), withKeyCopier(Class)
  - withValueCopier
```
B withValueCopier(Copier<V> valueCopier)
```
    Adds by-value semantics using the provided Copier for the value on heap.
    Copiers are what enable control of by-reference / by-value semantics for on-heap tier.
    
    Parameters:
    
    valueCopier - the value copier to use
    
    Returns:
    
    a new builder with the added value copier
    
    See Also:
    
    withValueSerializingCopier(), withValueCopier(Class), withoutValueCopier()
  - withValueCopier
```
B withValueCopier(java.lang.Class<? extends Copier<V>> valueCopierClass)
```
    Adds by-value semantics using the provided Copier class for the value on heap.
    Copiers are what enable control of by-reference / by-value semantics for on-heap tier.
    
    Parameters:
    
    valueCopierClass - the value copier class to use
    
    Returns:
    
    a new builder with the added value copier
    
    See Also:
    
    withValueSerializingCopier(), withValueCopier(Copier), withoutValueCopier()
  - withoutValueCopier
```
B withoutValueCopier()
```
    Removes any configured Copier for values on heap.
    
    Returns:
    
    a new builder without a value copier
    
    See Also:
    
    withValueSerializingCopier(), withValueCopier(Copier), withValueCopier(Class)
  - withKeySerializer
```
B withKeySerializer(Serializer<K> keySerializer)
```
    Sets the Serializer for cache keys in the returned builder.
    Serializers are what enables cache storage beyond the heap tier.
    
    Parameters:
    
    keySerializer - the key serializer to use
    
    Returns:
    
    a new builder with the added key serializer
    
    See Also:
    
    withKeySerializer(Class), withDefaultKeySerializer()
  - withKeySerializer
```
B withKeySerializer(java.lang.Class<? extends Serializer<K>> keySerializerClass)
```
    Sets the Serializer class for cache keys in the returned builder.
    Serializers are what enables cache storage beyond the heap tier.
    
    Parameters:
    
    keySerializerClass - the key serializer to use
    
    Returns:
    
    a new builder with the added key serializer
    
    See Also:
    
    withKeySerializer(Serializer), withDefaultKeySerializer()
  - withDefaultKeySerializer
```
B withDefaultKeySerializer()
```
    Removes any explicitly configured Serializer for cache keys.
    
    Returns:
    
    a new builder with no configured key serializer
    
    See Also:
    
    withKeySerializer(Serializer), withKeySerializer(Class)
  - withValueSerializer
```
B withValueSerializer(Serializer<V> valueSerializer)
```
    Sets the Serializer for cache values in the returned builder.
    Serializers are what enables cache storage beyond the heap tier.
    
    Parameters:
    
    valueSerializer - the key serializer to use
    
    Returns:
    
    a new builder with the added value serializer
    
    See Also:
    
    withValueSerializer(Class), withDefaultValueSerializer()
  - withValueSerializer
```
B withValueSerializer(java.lang.Class<? extends Serializer<V>> valueSerializerClass)
```
    Sets the Serializer class for cache values in the returned builder.
    Serializers are what enables cache storage beyond the heap tier.
    
    Parameters:
    
    valueSerializerClass - the key serializer to use
    
    Returns:
    
    a new builder with the added value serializer
    
    See Also:
    
    withValueSerializer(Serializer), withDefaultValueSerializer()
  - withDefaultValueSerializer
```
B withDefaultValueSerializer()
```
    Removes any explicitly configured Serializer for cache values.
    
    Returns:
    
    a new builder with no configured value serializer
    
    See Also:
    
    withValueSerializer(Serializer), withValueSerializer(Class)

Interface FluentCacheConfigurationBuilder<K,​V,​B extends FluentCacheConfigurationBuilder<K,​V,​?>>

Method Summary

Method Detail

build

getService

getServices

withService

withService

withoutServices

withoutServices

updateServices

withEvictionAdvisor

withClassLoader

withDefaultClassLoader

withResourcePools

withResourcePools

updateResourcePools

withExpiry

withLoaderWriter

withLoaderWriter

withoutLoaderWriter

withResilienceStrategy

withResilienceStrategy

withDefaultResilienceStrategy

withKeySerializingCopier

withValueSerializingCopier

withKeyCopier

withKeyCopier

withoutKeyCopier

withValueCopier

withValueCopier

withoutValueCopier

withKeySerializer

withKeySerializer

withDefaultKeySerializer

withValueSerializer

withValueSerializer

withDefaultValueSerializer

Interface FluentCacheConfigurationBuilder<K,V,B extends FluentCacheConfigurationBuilder<K,V,?>>