org.ehcache.config.builders

Class CacheConfigurationBuilder<K,V>

java.lang.Object

org.ehcache.config.builders.CacheConfigurationBuilder<K,V>

All Implemented Interfaces:

Builder<CacheConfiguration<K,V>>, FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

public class CacheConfigurationBuilder<K,V>
extends java.lang.Object
implements FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

The CacheConfigurationBuilder enables building CacheConfigurations using a fluent style.

As with all Ehcache builders, all instances are immutable and calling any method on the builder will return a new instance without modifying the one on which the method was called. This enables the sharing of builder instances without any risk of seeing them modified by code elsewhere.

Method Summary

Modifier and Type	Method and Description
CacheConfigurationBuilder<K,V>	add(Builder<? extends ServiceConfiguration<?,?>> configurationBuilder) Deprecated. in favor of FluentCacheConfigurationBuilder.withService(Builder)
CacheConfigurationBuilder<K,V>	add(ServiceConfiguration<?,?> configuration) Deprecated. in favor of withService(ServiceConfiguration)
CacheConfiguration<K,V>	build() Builds a new CacheConfiguration.
CacheConfigurationBuilder<K,V>	clearAllServiceConfig() Deprecated. in favor of withoutServices(ServiceConfiguration.class)
<T extends ServiceConfiguration<?,?>> T	getExistingServiceConfiguration(java.lang.Class<T> clazz) Deprecated. in favor of FluentCacheConfigurationBuilder.getService(Class)
<T extends ServiceConfiguration<?,?>> java.util.List<T>	getExistingServiceConfigurations(java.lang.Class<T> clazz) Deprecated. in favor of getServices(Class)
<C extends ServiceConfiguration<?,?>> java.util.Collection<C>	getServices(java.lang.Class<C> configurationType) Returns all the service configurations of the given type.
boolean	hasConfiguredExpiry() Indicates whether this builder has configured expiry or not.
static <K,V> CacheConfigurationBuilder<K,V>	newCacheConfigurationBuilder(CacheConfiguration<K,V> configuration) Creates a new instance ready to produce a CacheConfiguration functionally equivalent to the supplied configuration.
static <K,V> CacheConfigurationBuilder<K,V>	newCacheConfigurationBuilder(java.lang.Class<K> keyType, java.lang.Class<V> valueType, Builder<? extends ResourcePools> resourcePoolsBuilder) Creates a new instance ready to produce a CacheConfiguration with key type <K> and with value type <V> and which will use the configured resources, passed as a ResourcePoolsBuilder.
static <K,V> CacheConfigurationBuilder<K,V>	newCacheConfigurationBuilder(java.lang.Class<K> keyType, java.lang.Class<V> valueType, ResourcePools resourcePools) Creates a new instance ready to produce a CacheConfiguration with key type <K> and with value type <V> and which will use the configured resources.
CacheConfigurationBuilder<K,V>	remove(ServiceConfiguration<?,?> configuration) Deprecated. in favor of withoutServices(Class) or withoutServices(Class, Predicate)
CacheConfigurationBuilder<K,V>	updateResourcePools(java.util.function.UnaryOperator<ResourcePools> update) Updates the configured resource pools.
<R,C extends ServiceConfiguration<?,R>> CacheConfigurationBuilder<K,V>	updateServices(java.lang.Class<C> clazz, java.util.function.UnaryOperator<R> update) Updates all service configurations of the given type.
CacheConfigurationBuilder<K,V>	withClassLoader(java.lang.ClassLoader classLoader) Sets the ClassLoader in the returned builder.
CacheConfigurationBuilder<K,V>	withDefaultClassLoader() Removes any previously installed custom class loader
CacheConfigurationBuilder<K,V>	withDefaultDiskStoreThreadPool() Restores the default disk store thread pool settings.
CacheConfigurationBuilder<K,V>	withDefaultDispatcherConcurrency() Restores the default dispatcher concurrency.
CacheConfigurationBuilder<K,V>	withDefaultEventListenersThreadPool() Restores the default event listener thread pool settings.
CacheConfigurationBuilder<K,V>	withDefaultKeySerializer() Removes any explicitly configured Serializer for cache keys.
CacheConfigurationBuilder<K,V>	withDefaultResilienceStrategy() Restores configuration of the implementations default resilience strategy.
CacheConfigurationBuilder<K,V>	withDefaultSizeOfSettings() Restores the default size-of settings.
CacheConfigurationBuilder<K,V>	withDefaultValueSerializer() Removes any explicitly configured Serializer for cache values.
CacheConfigurationBuilder<K,V>	withDiskStoreThreadPool(java.lang.String threadPoolAlias, int concurrency) Adds a ServiceConfiguration for the OffHeapDiskStore.Provider indicating thread pool alias and write concurrency.
CacheConfigurationBuilder<K,V>	withDispatcherConcurrency(int dispatcherConcurrency) Adds StoreEventSourceConfiguration with the specified dispatcher concurrency to the configured builder.
CacheConfigurationBuilder<K,V>	withEventListenersThreadPool(java.lang.String threadPoolAlias) Adds a ServiceConfiguration for the CacheEventDispatcherFactory specifying the thread pool alias to use.
CacheConfigurationBuilder<K,V>	withEvictionAdvisor(EvictionAdvisor<? super K,? super V> evictionAdvisor) Sets the EvictionAdvisor in the returned builder.
CacheConfigurationBuilder<K,V>	withExpiry(Expiry<? super K,? super V> expiry) Deprecated. Use withExpiry(ExpiryPolicy) instead
CacheConfigurationBuilder<K,V>	withExpiry(ExpiryPolicy<? super K,? super V> expiry) Sets the ExpiryPolicy configuration in the returned builder.
CacheConfigurationBuilder<K,V>	withKeyCopier(java.lang.Class<? extends Copier<K>> keyCopierClass) Adds by-value semantics using the provided Copier class for the key on heap.
CacheConfigurationBuilder<K,V>	withKeyCopier(Copier<K> keyCopier) Adds by-value semantics using the provided Copier for the key on heap.
CacheConfigurationBuilder<K,V>	withKeySerializer(java.lang.Class<? extends Serializer<K>> keySerializerClass) Sets the Serializer class for cache keys in the returned builder.
CacheConfigurationBuilder<K,V>	withKeySerializer(Serializer<K> keySerializer) Sets the Serializer for cache keys in the returned builder.
CacheConfigurationBuilder<K,V>	withKeySerializingCopier() Adds by-value semantics using the cache key serializer for the key on heap.
CacheConfigurationBuilder<K,V>	withLoaderWriter(CacheLoaderWriter<K,V> loaderWriter) Sets the CacheLoaderWriter in the returned builder.
CacheConfigurationBuilder<K,V>	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.
CacheConfigurationBuilder<K,V>	withoutKeyCopier() Removes any configured Copier for keys on heap.
CacheConfigurationBuilder<K,V>	withoutLoaderWriter() Removes any configured loader-writer.
CacheConfigurationBuilder<K,V>	withoutServices(java.lang.Class<? extends ServiceConfiguration<?,?>> clazz) Removes all service configurations of the given type from this configuration.
<C extends ServiceConfiguration<?,?>> CacheConfigurationBuilder<K,V>	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.
CacheConfigurationBuilder<K,V>	withoutValueCopier() Removes any configured Copier for values on heap.
CacheConfigurationBuilder<K,V>	withResilienceStrategy(java.lang.Class<? extends ResilienceStrategy> resilienceStrategyClass, java.lang.Object... arguments) Sets the ResilienceStrategy (using a class and constructor arguments) in the returned builder.
CacheConfigurationBuilder<K,V>	withResilienceStrategy(ResilienceStrategy<K,V> resilienceStrategy) Sets the ResilienceStrategy in the returned builder.
CacheConfigurationBuilder<K,V>	withResourcePools(ResourcePools resourcePools) Sets the ResourcePools in the returned builder.
CacheConfigurationBuilder<K,V>	withService(ServiceConfiguration<?,?> config) Adds a service configuration to this configuration.
CacheConfigurationBuilder<K,V>	withSizeOfMaxObjectGraph(long size) Adds or updates the DefaultSizeOfEngineConfiguration with the specified object graph maximum size to the configured builder.
CacheConfigurationBuilder<K,V>	withSizeOfMaxObjectSize(long size, MemoryUnit unit) Adds or updates the DefaultSizeOfEngineConfiguration with the specified maximum mapping size to the configured builder.
CacheConfigurationBuilder<K,V>	withValueCopier(java.lang.Class<? extends Copier<V>> valueCopierClass) Adds by-value semantics using the provided Copier class for the value on heap.
CacheConfigurationBuilder<K,V>	withValueCopier(Copier<V> valueCopier) Adds by-value semantics using the provided Copier for the value on heap.
CacheConfigurationBuilder<K,V>	withValueSerializer(java.lang.Class<? extends Serializer<V>> valueSerializerClass) Sets the Serializer class for cache values in the returned builder.
CacheConfigurationBuilder<K,V>	withValueSerializer(Serializer<V> valueSerializer) Sets the Serializer for cache values in the returned builder.
CacheConfigurationBuilder<K,V>	withValueSerializingCopier() Adds by-value semantics using the cache value serializer for the value on heap.

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.FluentCacheConfigurationBuilder

getService, withResourcePools, withService

Method Detail

newCacheConfigurationBuilder

public static <K,V> CacheConfigurationBuilder<K,V> newCacheConfigurationBuilder(java.lang.Class<K> keyType,
                                                                                java.lang.Class<V> valueType,
                                                                                ResourcePools resourcePools)

Creates a new instance ready to produce a CacheConfiguration with key type <K> and with value type <V> and which will use the configured resources.

Type Parameters:

K - the key type

V - the value type

Parameters:

keyType - the key type

valueType - the value type

resourcePools - the resources to use

Returns:

a CacheConfigurationBuilder

newCacheConfigurationBuilder

public static <K,V> CacheConfigurationBuilder<K,V> newCacheConfigurationBuilder(java.lang.Class<K> keyType,
                                                                                java.lang.Class<V> valueType,
                                                                                Builder<? extends ResourcePools> resourcePoolsBuilder)

Creates a new instance ready to produce a CacheConfiguration with key type <K> and with value type <V> and which will use the configured resources, passed as a ResourcePoolsBuilder.

Type Parameters:

K - the key type

V - the value type

Parameters:

keyType - the key type

valueType - the value type

resourcePoolsBuilder - the resources to use, as a builder

Returns:

a CacheConfigurationBuilder

newCacheConfigurationBuilder

public static <K,V> CacheConfigurationBuilder<K,V> newCacheConfigurationBuilder(CacheConfiguration<K,V> configuration)

Creates a new instance ready to produce a CacheConfiguration functionally equivalent to the supplied configuration.

Type Parameters:

K - the key type

V - the value type

Parameters:

configuration - seed configuration

Returns:

a CacheConfigurationBuilder

add

@Deprecated
public CacheConfigurationBuilder<K,V> add(ServiceConfiguration<?,?> configuration)

Deprecated. in favor of withService(ServiceConfiguration)

Adds a ServiceConfiguration to the returned builder.

Parameters:

configuration - the service configuration to add

Returns:

a new builder with the added service configuration

add

@Deprecated
public CacheConfigurationBuilder<K,V> add(Builder<? extends ServiceConfiguration<?,?>> configurationBuilder)

Deprecated. in favor of FluentCacheConfigurationBuilder.withService(Builder)

Convenience method to add a ServiceConfiguration that is produced by a Builder.

Parameters:

configurationBuilder - the service configuration to add, Builder.build() will be called on it

Returns:

a new builder with the added service configuration

See Also:

add(ServiceConfiguration)

getServices

public <C extends ServiceConfiguration<?,?>> java.util.Collection<C> getServices(java.lang.Class<C> configurationType)
                                                                          throws java.lang.IllegalArgumentException

Description copied from interface: FluentCacheConfigurationBuilder

Returns all the service configurations of the given type.

Specified by:

getServices in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Type Parameters:

C - configuration type

Parameters:

configurationType - desired configuration type

Returns:

all services of this type

Throws:

java.lang.IllegalArgumentException

See Also:

FluentCacheConfigurationBuilder.getService(Class), FluentCacheConfigurationBuilder.withService(ServiceConfiguration), FluentCacheConfigurationBuilder.withService(Builder), FluentCacheConfigurationBuilder.withoutServices(Class), FluentCacheConfigurationBuilder.withoutServices(Class, Predicate), FluentCacheConfigurationBuilder.updateServices(Class, UnaryOperator)

withService

public CacheConfigurationBuilder<K,V> withService(ServiceConfiguration<?,?> config)

Description copied from interface: FluentCacheConfigurationBuilder

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)
 );

Specified by:

withService in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

config - service configuration

Returns:

an updated builder

See Also:

ServiceConfiguration.compatibleWith(ServiceConfiguration), FluentCacheConfigurationBuilder.getService(Class), FluentCacheConfigurationBuilder.getServices(Class), FluentCacheConfigurationBuilder.withService(Builder), FluentCacheConfigurationBuilder.withoutServices(Class), FluentCacheConfigurationBuilder.withoutServices(Class, Predicate), FluentCacheConfigurationBuilder.updateServices(Class, UnaryOperator)

withoutServices

public CacheConfigurationBuilder<K,V> withoutServices(java.lang.Class<? extends ServiceConfiguration<?,?>> clazz)

Description copied from interface: FluentCacheConfigurationBuilder

Removes all service configurations of the given type from this configuration.

Specified by:

withoutServices in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

clazz - service configuration type

Returns:

an updated builder

See Also:

FluentCacheConfigurationBuilder.getService(Class), FluentCacheConfigurationBuilder.getServices(Class), FluentCacheConfigurationBuilder.withService(ServiceConfiguration), FluentCacheConfigurationBuilder.withService(Builder), FluentCacheConfigurationBuilder.withoutServices(Class, Predicate), FluentCacheConfigurationBuilder.updateServices(Class, UnaryOperator)

withoutServices

public <C extends ServiceConfiguration<?,?>> CacheConfigurationBuilder<K,V> withoutServices(java.lang.Class<C> clazz,
                                                                                            java.util.function.Predicate<? super C> predicate)

Description copied from interface: FluentCacheConfigurationBuilder

Removes all service configurations of the given type that pass the predicate.

Specified by:

withoutServices in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Type Parameters:

C - configuration type

Parameters:

clazz - service configuration type

predicate - predicate controlling removal

Returns:

an updated builder

See Also:

FluentCacheConfigurationBuilder.getService(Class), FluentCacheConfigurationBuilder.getServices(Class), FluentCacheConfigurationBuilder.withService(ServiceConfiguration), FluentCacheConfigurationBuilder.withService(Builder), FluentCacheConfigurationBuilder.withoutServices(Class), FluentCacheConfigurationBuilder.updateServices(Class, UnaryOperator)

updateServices

public <R,C extends ServiceConfiguration<?,R>> CacheConfigurationBuilder<K,V> updateServices(java.lang.Class<C> clazz,
                                                                                             java.util.function.UnaryOperator<R> update)

Description copied from interface: FluentCacheConfigurationBuilder

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:

1. The configuration is converted to its detached representations using the ServiceConfiguration.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 ServiceConfiguration.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 FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

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

See Also:

FluentCacheConfigurationBuilder.getService(Class), FluentCacheConfigurationBuilder.getServices(Class), FluentCacheConfigurationBuilder.withService(ServiceConfiguration), FluentCacheConfigurationBuilder.withService(Builder), FluentCacheConfigurationBuilder.withoutServices(Class), FluentCacheConfigurationBuilder.withoutServices(Class, Predicate)

withEvictionAdvisor

public CacheConfigurationBuilder<K,V> withEvictionAdvisor(EvictionAdvisor<? super K,? super V> evictionAdvisor)

Description copied from interface: FluentCacheConfigurationBuilder

Sets the EvictionAdvisor in the returned builder.

Specified by:

withEvictionAdvisor in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

evictionAdvisor - the eviction advisor to be used

Returns:

a new builder with the added eviction advisor

See Also:

Eviction.NO_ADVICE

remove

@Deprecated
public CacheConfigurationBuilder<K,V> remove(ServiceConfiguration<?,?> configuration)

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

Removes a ServiceConfiguration from the returned builder.

Parameters:

configuration - the service configuration to remove

Returns:

a new builder without the specified configuration

clearAllServiceConfig

@Deprecated
public CacheConfigurationBuilder<K,V> clearAllServiceConfig()

Deprecated. in favor of withoutServices(ServiceConfiguration.class)

Clears all ServiceConfigurations from the returned builder.

Returns:

a new builder with no service configurations left

getExistingServiceConfiguration

@Deprecated
public <T extends ServiceConfiguration<?,?>> T getExistingServiceConfiguration(java.lang.Class<T> clazz)

Deprecated. in favor of FluentCacheConfigurationBuilder.getService(Class)

Returns the first ServiceConfiguration with type matching the class passed in.

Type Parameters:

T - the type of the service configuration

Parameters:

clazz - the service configuration class

Returns:

a matching service configuration, or null if none can be found

getExistingServiceConfigurations

@Deprecated
public <T extends ServiceConfiguration<?,?>> java.util.List<T> getExistingServiceConfigurations(java.lang.Class<T> clazz)

Deprecated. in favor of getServices(Class)

Returns all ServiceConfigurations of type matching the class passed in.

Type Parameters:

T - the type of the service configuration

Parameters:

clazz - the service configuration class

Returns:

a list with service configurations

withClassLoader

public CacheConfigurationBuilder<K,V> withClassLoader(java.lang.ClassLoader classLoader)

Description copied from interface: FluentCacheConfigurationBuilder

Sets the ClassLoader in the returned builder.

The ClassLoader will be used for resolving all non Ehcache types.

Specified by:

withClassLoader in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

classLoader - the class loader to use

Returns:

a new builder with the added class loader

See Also:

FluentCacheConfigurationBuilder.withDefaultClassLoader()

withDefaultClassLoader

public CacheConfigurationBuilder<K,V> withDefaultClassLoader()

Description copied from interface: FluentCacheConfigurationBuilder

Removes any previously installed custom class loader

Specified by:

withDefaultClassLoader in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Returns:

a new build using the default class loader

See Also:

FluentCacheConfigurationBuilder.withClassLoader(ClassLoader)

withResourcePools

public CacheConfigurationBuilder<K,V> withResourcePools(ResourcePools resourcePools)

Description copied from interface: FluentCacheConfigurationBuilder

Sets the ResourcePools in the returned builder.

ResourcePools is what determines the tiering of a cache.

Specified by:

withResourcePools in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

resourcePools - the resource pools to use

Returns:

a new builder with the added resource pools

See Also:

FluentCacheConfigurationBuilder.withResourcePools(Builder), FluentCacheConfigurationBuilder.updateResourcePools(UnaryOperator)

updateResourcePools

public CacheConfigurationBuilder<K,V> updateResourcePools(java.util.function.UnaryOperator<ResourcePools> update)

Description copied from interface: FluentCacheConfigurationBuilder

Updates the configured resource pools.

Specified by:

updateResourcePools in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

update - resource pool update operation

Returns:

a new build with updated resource pools

See Also:

FluentCacheConfigurationBuilder.withResourcePools(ResourcePools), FluentCacheConfigurationBuilder.withResourcePools(Builder)

withExpiry

@Deprecated
public CacheConfigurationBuilder<K,V> withExpiry(Expiry<? super K,? super V> expiry)

Deprecated. Use withExpiry(ExpiryPolicy) instead

Adds Expiry configuration to the returned builder.

Expiry is what controls data freshness in a cache.

Parameters:

expiry - the expiry to use

Returns:

a new builder with the added expiry

withExpiry

public CacheConfigurationBuilder<K,V> withExpiry(ExpiryPolicy<? super K,? super V> expiry)

Description copied from interface: FluentCacheConfigurationBuilder

Sets the ExpiryPolicy configuration in the returned builder.

ExpiryPolicy is what controls data freshness in a cache.

Specified by:

withExpiry in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

expiry - the expiry to use

Returns:

a new builder with the added expiry

See Also:

ExpiryPolicy.NO_EXPIRY

hasConfiguredExpiry

public boolean hasConfiguredExpiry()

Indicates whether this builder has configured expiry or not.

Returns:

true if expiry configured, false otherwise

withLoaderWriter

public CacheConfigurationBuilder<K,V> withLoaderWriter(CacheLoaderWriter<K,V> loaderWriter)

Description copied from interface: FluentCacheConfigurationBuilder

Sets the CacheLoaderWriter in the returned builder.

Configuration of a CacheLoaderWriter is what enables cache-through patterns.

Specified by:

withLoaderWriter in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

loaderWriter - the loaderwriter to use

Returns:

a new builder with the added loaderwriter configuration

See Also:

FluentCacheConfigurationBuilder.withLoaderWriter(Class, Object...), FluentCacheConfigurationBuilder.withoutLoaderWriter()

withLoaderWriter

public CacheConfigurationBuilder<K,V> withLoaderWriter(java.lang.Class<CacheLoaderWriter<K,V>> loaderWriterClass,
                                                       java.lang.Object... arguments)

Description copied from interface: FluentCacheConfigurationBuilder

Sets the CacheLoaderWriter (using a class and constructor arguments) in the returned builder.

Configuration of a CacheLoaderWriter is what enables cache-through patterns.

Specified by:

withLoaderWriter in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

loaderWriterClass - the loaderwrite class

arguments - optional constructor arguments

Returns:

a new builder with the added loaderwriter configuration

See Also:

FluentCacheConfigurationBuilder.withLoaderWriter(CacheLoaderWriter), FluentCacheConfigurationBuilder.withoutLoaderWriter()

withoutLoaderWriter

public CacheConfigurationBuilder<K,V> withoutLoaderWriter()

Description copied from interface: FluentCacheConfigurationBuilder

Removes any configured loader-writer.

Specified by:

withoutLoaderWriter in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Returns:

a new build with no configured loader-writer

See Also:

FluentCacheConfigurationBuilder.withLoaderWriter(CacheLoaderWriter), FluentCacheConfigurationBuilder.withLoaderWriter(Class, Object...)

withResilienceStrategy

public CacheConfigurationBuilder<K,V> withResilienceStrategy(ResilienceStrategy<K,V> resilienceStrategy)

Description copied from interface: FluentCacheConfigurationBuilder

Sets the ResilienceStrategy in the returned builder.

Specified by:

withResilienceStrategy in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

resilienceStrategy - the resilience strategy to use

Returns:

a new builder with the added resilience strategy configuration

See Also:

FluentCacheConfigurationBuilder.withResilienceStrategy(Class, Object...), FluentCacheConfigurationBuilder.withDefaultResilienceStrategy()

withResilienceStrategy

public CacheConfigurationBuilder<K,V> withResilienceStrategy(java.lang.Class<? extends ResilienceStrategy> resilienceStrategyClass,
                                                             java.lang.Object... arguments)

Description copied from interface: FluentCacheConfigurationBuilder

Sets the ResilienceStrategy (using a class and constructor arguments) in the returned builder.

Specified by:

withResilienceStrategy in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

resilienceStrategyClass - the resilience strategy class

arguments - optional constructor arguments

Returns:

a new builder with the added resilience strategy configuration

See Also:

FluentCacheConfigurationBuilder.withResilienceStrategy(ResilienceStrategy), FluentCacheConfigurationBuilder.withDefaultResilienceStrategy()

withDefaultResilienceStrategy

public CacheConfigurationBuilder<K,V> withDefaultResilienceStrategy()

Description copied from interface: FluentCacheConfigurationBuilder

Restores configuration of the implementations default resilience strategy.

Specified by:

withDefaultResilienceStrategy in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Returns:

a new builder using the default resilience strategy

See Also:

FluentCacheConfigurationBuilder.withResilienceStrategy(ResilienceStrategy), FluentCacheConfigurationBuilder.withResilienceStrategy(Class, Object...)

withKeySerializingCopier

public CacheConfigurationBuilder<K,V> withKeySerializingCopier()

Description copied from interface: FluentCacheConfigurationBuilder

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.

Specified by:

withKeySerializingCopier in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Returns:

a new builder with the added key copier

See Also:

FluentCacheConfigurationBuilder.withKeyCopier(Copier), FluentCacheConfigurationBuilder.withKeyCopier(Class), FluentCacheConfigurationBuilder.withoutKeyCopier()

withValueSerializingCopier

public CacheConfigurationBuilder<K,V> withValueSerializingCopier()

Description copied from interface: FluentCacheConfigurationBuilder

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.

Specified by:

withValueSerializingCopier in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Returns:

a new builder with the added value copier

See Also:

FluentCacheConfigurationBuilder.withValueCopier(Copier), FluentCacheConfigurationBuilder.withValueCopier(Class), FluentCacheConfigurationBuilder.withoutValueCopier()

withKeyCopier

public CacheConfigurationBuilder<K,V> withKeyCopier(Copier<K> keyCopier)

Description copied from interface: FluentCacheConfigurationBuilder

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.

Specified by:

withKeyCopier in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

keyCopier - the key copier to use

Returns:

a new builder with the added key copier

See Also:

FluentCacheConfigurationBuilder.withKeySerializingCopier(), FluentCacheConfigurationBuilder.withKeyCopier(Class), FluentCacheConfigurationBuilder.withoutKeyCopier()

withKeyCopier

public CacheConfigurationBuilder<K,V> withKeyCopier(java.lang.Class<? extends Copier<K>> keyCopierClass)

Description copied from interface: FluentCacheConfigurationBuilder

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.

Specified by:

withKeyCopier in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

keyCopierClass - the key copier class to use

Returns:

a new builder with the added key copier

See Also:

FluentCacheConfigurationBuilder.withKeySerializingCopier(), FluentCacheConfigurationBuilder.withKeyCopier(Copier), FluentCacheConfigurationBuilder.withoutKeyCopier()

withoutKeyCopier

public CacheConfigurationBuilder<K,V> withoutKeyCopier()

Description copied from interface: FluentCacheConfigurationBuilder

Removes any configured Copier for keys on heap.

Specified by:

withoutKeyCopier in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Returns:

a new builder without a key copier

See Also:

FluentCacheConfigurationBuilder.withKeySerializingCopier(), FluentCacheConfigurationBuilder.withKeyCopier(Copier), FluentCacheConfigurationBuilder.withKeyCopier(Class)

withValueCopier

public CacheConfigurationBuilder<K,V> withValueCopier(Copier<V> valueCopier)

Description copied from interface: FluentCacheConfigurationBuilder

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.

Specified by:

withValueCopier in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

valueCopier - the value copier to use

Returns:

a new builder with the added value copier

See Also:

FluentCacheConfigurationBuilder.withValueSerializingCopier(), FluentCacheConfigurationBuilder.withValueCopier(Class), FluentCacheConfigurationBuilder.withoutValueCopier()

withValueCopier

public CacheConfigurationBuilder<K,V> withValueCopier(java.lang.Class<? extends Copier<V>> valueCopierClass)

Description copied from interface: FluentCacheConfigurationBuilder

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.

Specified by:

withValueCopier in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

valueCopierClass - the value copier class to use

Returns:

a new builder with the added value copier

See Also:

FluentCacheConfigurationBuilder.withValueSerializingCopier(), FluentCacheConfigurationBuilder.withValueCopier(Copier), FluentCacheConfigurationBuilder.withoutValueCopier()

withoutValueCopier

public CacheConfigurationBuilder<K,V> withoutValueCopier()

Description copied from interface: FluentCacheConfigurationBuilder

Removes any configured Copier for values on heap.

Specified by:

withoutValueCopier in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Returns:

a new builder without a value copier

See Also:

FluentCacheConfigurationBuilder.withValueSerializingCopier(), FluentCacheConfigurationBuilder.withValueCopier(Copier), FluentCacheConfigurationBuilder.withValueCopier(Class)

withKeySerializer

public CacheConfigurationBuilder<K,V> withKeySerializer(Serializer<K> keySerializer)

Description copied from interface: FluentCacheConfigurationBuilder

Sets the Serializer for cache keys in the returned builder.

Serializers are what enables cache storage beyond the heap tier.

Specified by:

withKeySerializer in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

keySerializer - the key serializer to use

Returns:

a new builder with the added key serializer

See Also:

FluentCacheConfigurationBuilder.withKeySerializer(Class), FluentCacheConfigurationBuilder.withDefaultKeySerializer()

withKeySerializer

public CacheConfigurationBuilder<K,V> withKeySerializer(java.lang.Class<? extends Serializer<K>> keySerializerClass)

Description copied from interface: FluentCacheConfigurationBuilder

Sets the Serializer class for cache keys in the returned builder.

Serializers are what enables cache storage beyond the heap tier.

Specified by:

withKeySerializer in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

keySerializerClass - the key serializer to use

Returns:

a new builder with the added key serializer

See Also:

FluentCacheConfigurationBuilder.withKeySerializer(Serializer), FluentCacheConfigurationBuilder.withDefaultKeySerializer()

withDefaultKeySerializer

public CacheConfigurationBuilder<K,V> withDefaultKeySerializer()

Description copied from interface: FluentCacheConfigurationBuilder

Removes any explicitly configured Serializer for cache keys.

Specified by:

withDefaultKeySerializer in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Returns:

a new builder with no configured key serializer

See Also:

FluentCacheConfigurationBuilder.withKeySerializer(Serializer), FluentCacheConfigurationBuilder.withKeySerializer(Class)

withValueSerializer

public CacheConfigurationBuilder<K,V> withValueSerializer(Serializer<V> valueSerializer)

Description copied from interface: FluentCacheConfigurationBuilder

Sets the Serializer for cache values in the returned builder.

Serializers are what enables cache storage beyond the heap tier.

Specified by:

withValueSerializer in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

valueSerializer - the key serializer to use

Returns:

a new builder with the added value serializer

See Also:

FluentCacheConfigurationBuilder.withValueSerializer(Class), FluentCacheConfigurationBuilder.withDefaultValueSerializer()

withValueSerializer

public CacheConfigurationBuilder<K,V> withValueSerializer(java.lang.Class<? extends Serializer<V>> valueSerializerClass)

Description copied from interface: FluentCacheConfigurationBuilder

Sets the Serializer class for cache values in the returned builder.

Serializers are what enables cache storage beyond the heap tier.

Specified by:

withValueSerializer in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Parameters:

valueSerializerClass - the key serializer to use

Returns:

a new builder with the added value serializer

See Also:

FluentCacheConfigurationBuilder.withValueSerializer(Serializer), FluentCacheConfigurationBuilder.withDefaultValueSerializer()

withDefaultValueSerializer

public CacheConfigurationBuilder<K,V> withDefaultValueSerializer()

Description copied from interface: FluentCacheConfigurationBuilder

Removes any explicitly configured Serializer for cache values.

Specified by:

withDefaultValueSerializer in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Returns:

a new builder with no configured value serializer

See Also:

FluentCacheConfigurationBuilder.withValueSerializer(Serializer), FluentCacheConfigurationBuilder.withValueSerializer(Class)

withDispatcherConcurrency

public CacheConfigurationBuilder<K,V> withDispatcherConcurrency(int dispatcherConcurrency)

Adds StoreEventSourceConfiguration with the specified dispatcher concurrency to the configured builder.

Parameters:

dispatcherConcurrency - the level of concurrency in the dispatcher for ordered events

Returns:

a new builder with the added configuration

See Also:

withDefaultDispatcherConcurrency()

withDefaultDispatcherConcurrency

public CacheConfigurationBuilder<K,V> withDefaultDispatcherConcurrency()

Restores the default dispatcher concurrency.

Returns:

a new builder with the default dispatcher concurrency

See Also:

withDispatcherConcurrency(int)

withEventListenersThreadPool

public CacheConfigurationBuilder<K,V> withEventListenersThreadPool(java.lang.String threadPoolAlias)

Adds a ServiceConfiguration for the CacheEventDispatcherFactory specifying the thread pool alias to use.

Parameters:

threadPoolAlias - the thread pool alias to use

Returns:

a new builder with the added configuration

See Also:

withDefaultEventListenersThreadPool()

withDefaultEventListenersThreadPool

public CacheConfigurationBuilder<K,V> withDefaultEventListenersThreadPool()

Restores the default event listener thread pool settings.

Returns:

a new builder with the default event listener thread pool settings

See Also:

withEventListenersThreadPool(String)

withDiskStoreThreadPool

public CacheConfigurationBuilder<K,V> withDiskStoreThreadPool(java.lang.String threadPoolAlias,
                                                              int concurrency)

Adds a ServiceConfiguration for the OffHeapDiskStore.Provider indicating thread pool alias and write concurrency.

Parameters:

threadPoolAlias - the thread pool alias

concurrency - the write concurrency

Returns:

a new builder with the added configuration

See Also:

withDefaultDiskStoreThreadPool()

withDefaultDiskStoreThreadPool

public CacheConfigurationBuilder<K,V> withDefaultDiskStoreThreadPool()

Restores the default disk store thread pool settings.

Returns:

a new builder with the default disk store thread pool settings

See Also:

withDiskStoreThreadPool(String, int)

withSizeOfMaxObjectGraph

public CacheConfigurationBuilder<K,V> withSizeOfMaxObjectGraph(long size)

Adds or updates the DefaultSizeOfEngineConfiguration with the specified object graph maximum size to the configured builder.

SizeOfEngine is what enables the heap tier to be sized in MemoryUnit.

Parameters:

size - the maximum graph size

Returns:

a new builder with the added / updated configuration

See Also:

withSizeOfMaxObjectSize(long, MemoryUnit), withDefaultSizeOfSettings()

withSizeOfMaxObjectSize

public CacheConfigurationBuilder<K,V> withSizeOfMaxObjectSize(long size,
                                                              MemoryUnit unit)

Adds or updates the DefaultSizeOfEngineConfiguration with the specified maximum mapping size to the configured builder.

SizeOfEngine is what enables the heap tier to be sized in MemoryUnit.

Parameters:

size - the maximum mapping size

unit - the memory unit

Returns:

a new builder with the added / updated configuration

See Also:

withSizeOfMaxObjectGraph(long), withDefaultSizeOfSettings()

withDefaultSizeOfSettings

public CacheConfigurationBuilder<K,V> withDefaultSizeOfSettings()

Restores the default size-of settings.

Returns:

a new builder with the default size-of settings

See Also:

withSizeOfMaxObjectGraph(long), withSizeOfMaxObjectSize(long, MemoryUnit)

build

public CacheConfiguration<K,V> build()

Description copied from interface: FluentCacheConfigurationBuilder

Builds a new CacheConfiguration.

Specified by:

build in interface Builder<CacheConfiguration<K,V>>

Specified by:

build in interface FluentCacheConfigurationBuilder<K,V,CacheConfigurationBuilder<K,V>>

Returns:

a new CacheConfiguration