Package org.ehcache.config

Interface FluentConfigurationBuilder<B extends FluentConfigurationBuilder<?>>

Type Parameters:

B - builder sub-type

All Superinterfaces:

Builder<Configuration>

public interface FluentConfigurationBuilder<B extends FluentConfigurationBuilder<?>>
extends Builder<Configuration>

A fluent builder of Configuration instances.

Method Summary

Modifier and Type	Method	Description
CacheConfiguration<?,?>	getCache(String alias)	Return the cache configuration for the given alias.
ClassLoader	getClassLoader()	Return the configured classloader instance.
default <C extends ServiceCreationConfiguration<?, ?>> C	getService(Class<C> configurationType)	Return the unique service creation configuration of the given type.
<C extends ServiceCreationConfiguration<?, ?>> Collection<C>	getServices(Class<C> configurationType)	Return the service creation configurations of the given type.
B	updateCache(String alias, UnaryOperator<FluentCacheConfigurationBuilder<?,?,?>> update)	Updates the configuration of the identified cache.
B	updateCaches(UnaryOperator<FluentCacheConfigurationBuilder<?,?,?>> update)	Updates the configuration of the all caches.
<R, C extends ServiceCreationConfiguration<?, R>> B	updateServices(Class<C> clazz, UnaryOperator<R> update)	Updates all service creation configurations of the given type.
B	updateSharedResources(UnaryOperator<ResourcePools> update)	Updates the configured shared resource pools.
default B	withCache(String alias, Builder<? extends CacheConfiguration<?,?>> builder)	Adds the cache configuration built by a builder to this configuration.
B	withCache(String alias, CacheConfiguration<?,?> config)	Adds the given cache to this configuration.
B	withClassLoader(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(String alias)	Removes the given cache from this configuration.
default B	withoutServices(Class<? extends ServiceCreationConfiguration<?,?>> clazz)	Removes all service creation configurations of the given type from this configuration.
<C extends ServiceCreationConfiguration<?, ?>> B	withoutServices(Class<C> clazz, Predicate<? super C> predicate)	Removes all service creation configurations of the given type that pass the predicate.
default B	withService(Builder<? extends ServiceCreationConfiguration<?,?>> builder)	Adds a service creation configuration built by the given builder to this configuration.
B	withService(ServiceCreationConfiguration<?,?> config)	Adds a service creation configuration to this configuration.
default B	withSharedResources(Builder<? extends ResourcePools> builder)	Convenience method to set the shared ResourcePools through a Builder.
B	withSharedResources(ResourcePools resourcePools)	Sets the shared ResourcePools in the returned builder.

Methods inherited from interface org.ehcache.config.Builder

build

Method Details

getCache

CacheConfiguration<?,?> getCache(String alias)

Return the cache configuration for the given alias.

Parameters:

alias - cache alias

Returns:

associated cache configuration

See Also:

• withCache(String, CacheConfiguration)
• withCache(String, Builder)
• updateCache(String, UnaryOperator)
• withoutCache(String)
• updateCaches(UnaryOperator)

withCache

B withCache(String alias,
 CacheConfiguration<?,?> config)

Adds the given cache to this configuration.

This will overwrite any existing configuration for the cache with this alias.

Parameters:

alias - cache alias

config - cache configuration

Returns:

an updated builder

See Also:

• getCache(String)
• withCache(String, Builder)
• updateCache(String, UnaryOperator)
• withoutCache(String)
• updateCaches(UnaryOperator)

withSharedResources

B withSharedResources(ResourcePools resourcePools)

Sets the shared ResourcePools in the returned builder.

Shared ResourcePools are optionally available to all caches within a cache manager.

Parameters:

resourcePools - the resource pools to use

Returns:

a new builder with the added shared resource pools

See Also:

• (Builder)
• updateSharedResources(UnaryOperator)

withSharedResources

default B withSharedResources(Builder<? extends ResourcePools> builder)

Convenience method to set the shared ResourcePools through a Builder.

Parameters:

builder - the builder providing the resource pool

Returns:

a new builder with the added shared resource pools

See Also:

• withSharedResources(ResourcePools)
• updateSharedResources(UnaryOperator)

updateSharedResources

B updateSharedResources(UnaryOperator<ResourcePools> update)

Updates the configured shared resource pools.

Parameters:

update - resource pool update operation

Returns:

a new build with updated resource pools

See Also:

• withSharedResources(ResourcePools)
• withSharedResources(Builder)

withCache

default B withCache(String alias,
 Builder<? extends CacheConfiguration<?,?>> builder)

Adds the cache configuration built by a builder to this configuration.

This will overwrite any existing configuration for the cache with this alias.

Parameters:

alias - cache alias

builder - cache configuration builder

Returns:

an updated builder

See Also:

• getCache(String)
• withCache(String, Builder)
• updateCache(String, UnaryOperator)
• withoutCache(String)
• updateCaches(UnaryOperator)

withoutCache

B withoutCache(String alias)

Removes the given cache from this configuration.

Parameters:

alias - cache alias

Returns:

an updated builder

See Also:

• getCache(String)
• withCache(String, CacheConfiguration)
• withCache(String, Builder)
• updateCache(String, UnaryOperator)
• updateCaches(UnaryOperator)

updateCache

B updateCache(String alias,
 UnaryOperator<FluentCacheConfigurationBuilder<?,?,?>> update)
       throws IllegalArgumentException

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.

Parameters:

alias - cache alias

update - configuration mutation function

Returns:

an updated builder

Throws:

IllegalArgumentException - if no cache configuration exists for alias

See Also:

• getCache(String)
• withCache(String, CacheConfiguration)
• withCache(String, Builder)
• withoutCache(String)
• updateCaches(UnaryOperator)

updateCaches

B updateCaches(UnaryOperator<FluentCacheConfigurationBuilder<?,?,?>> update)

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.

Parameters:

update - configuration mutation function

Returns:

an updated builder

See Also:

• getCache(String)
• withCache(String, CacheConfiguration)
• withCache(String, Builder)
• updateCache(String, UnaryOperator)
• withoutCache(String)

getService

default <C extends ServiceCreationConfiguration<?,
?>>
C getService(Class<C> configurationType)
      throws IllegalArgumentException

Return the unique service creation 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 given configuration type

Throws:

IllegalArgumentException - if there are multiple instances of this type

See Also:

• getServices(Class)
• withService(ServiceCreationConfiguration)
• withService(Builder)
• withoutServices(Class)
• withoutServices(Class, Predicate)
• updateServices(Class, UnaryOperator)

getServices

<C extends ServiceCreationConfiguration<?,
?>>
Collection<C> getServices(Class<C> configurationType)

Return the service creation 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(ServiceCreationConfiguration)
• withService(Builder)
• withoutServices(Class)
• withoutServices(Class, Predicate)
• updateServices(Class, UnaryOperator)

withService

B withService(ServiceCreationConfiguration<?,?> config)

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

Parameters:

config - service creation configuration

Returns:

an updated builder

See Also:

• ServiceCreationConfiguration.compatibleWith(ServiceCreationConfiguration)
• getService(Class)
• getServices(Class)
• withService(Builder)
• withoutServices(Class)
• withoutServices(Class, Predicate)
• updateServices(Class, UnaryOperator)

withService

default B withService(Builder<? extends ServiceCreationConfiguration<?,?>> builder)

Adds a service creation configuration built by the given builder to this configuration.

This will remove any existing configurations that are incompatible with the supplied one.

Parameters:

builder - service creation configuration builder

Returns:

an updated builder

See Also:

• getService(Class)
• getServices(Class)
• withService(ServiceCreationConfiguration)
• withoutServices(Class)
• withoutServices(Class, Predicate)
• updateServices(Class, UnaryOperator)

withoutServices

default B withoutServices(Class<? extends ServiceCreationConfiguration<?,?>> clazz)

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

Parameters:

clazz - service configuration type

Returns:

an updated builder

See Also:

• getService(Class)
• getServices(Class)
• withService(ServiceCreationConfiguration)
• withService(Builder)
• withoutServices(Class, Predicate)
• updateServices(Class, UnaryOperator)

withoutServices

<C extends ServiceCreationConfiguration<?,
?>> B withoutServices(Class<C> clazz,
 Predicate<? super C> predicate)

Removes all service creation 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(ServiceCreationConfiguration)
• withService(Builder)
• withoutServices(Class)
• updateServices(Class, UnaryOperator)

updateServices

<R,
C extends ServiceCreationConfiguration<?,
R>> B updateServices(Class<C> clazz,
 UnaryOperator<R> update)
                                                          throws IllegalStateException

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.

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

Throws:

IllegalStateException - if no configurations of type C exist

See Also:

• getService(Class)
• getServices(Class)
• withService(ServiceCreationConfiguration)
• withService(Builder)
• withoutServices(Class)
• withoutServices(Class, Predicate)

getClassLoader

ClassLoader getClassLoader()

Return the configured classloader instance.

Returns:

configured classloader

See Also:

• withClassLoader(ClassLoader)
• withDefaultClassLoader()

withClassLoader

B withClassLoader(ClassLoader classLoader)

Sets the given class loader as the cache manager classloader

Parameters:

classLoader - cache manager classloader

Returns:

an updated builder

See Also:

• getClassLoader()
• withDefaultClassLoader()

withDefaultClassLoader

B withDefaultClassLoader()

Removes any provided class loader returning to default behavior

Returns:

an updated builder

See Also:

• getClassLoader()
• withClassLoader(ClassLoader)