org.ehcache.config.builders

Class ResourcePoolsBuilder

java.lang.Object

org.ehcache.config.builders.ResourcePoolsBuilder

All Implemented Interfaces:

Builder<ResourcePools>

public class ResourcePoolsBuilder
extends java.lang.Object
implements Builder<ResourcePools>

The ResourcePoolsBuilder enables building ResourcePools configurations 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
ResourcePools	build() Builds the ResourcePools based on this builder's configuration.
ResourcePoolsBuilder	disk(long size, MemoryUnit unit) Convenience method to add a non persistent disk pool.
ResourcePoolsBuilder	disk(long size, MemoryUnit unit, boolean persistent) Convenience method to add a disk pool specifying persistence.
static ResourcePoolsBuilder	heap(long entries) Creates a new ResourcePoolsBuilder with a heap pool sized in entries
ResourcePoolsBuilder	heap(long size, ResourceUnit unit) Convenience method to add a heap pool.
static ResourcePoolsBuilder	newResourcePoolsBuilder() Creates a new ResourcePoolsBuilder.
static ResourcePoolsBuilder	newResourcePoolsBuilder(ResourcePools pools) Convenience method to get a builder from an existing ResourcePools.
ResourcePoolsBuilder	offheap(long size, MemoryUnit unit) Convenience method to add an offheap pool.
ResourcePoolsBuilder	shared(ResourceType<?> type)
ResourcePoolsBuilder	shared(ResourceType<?> type, boolean persistent)
ResourcePoolsBuilder	sharedDisk() Informs the cache manager that an existing disk shared pool, defined on the cache manager, should be used for the cache's disk caching requirements.
ResourcePoolsBuilder	sharedHeap() Informs the cache manager that an existing heap shared pool, defined on the cache manager, should be used for the cache's on-heap caching requirements.
ResourcePoolsBuilder	sharedOffheap() Informs the cache manager that an existing offheap shared pool, defined on the cache manager, should be used for the cache's offheap caching requirements.
ResourcePoolsBuilder	with(ResourcePool resourcePool) Add the ResourcePool of ResourceType in the returned builder.
ResourcePoolsBuilder	with(ResourceType<SizedResourcePool> type, long size, ResourceUnit unit, boolean persistent) Add the ResourcePool of ResourceType in the returned builder.
ResourcePoolsBuilder	withReplacing(ResourcePool resourcePool) Add or replace the ResourcePool of ResourceType in the returned builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newResourcePoolsBuilder

public static ResourcePoolsBuilder newResourcePoolsBuilder()

Creates a new ResourcePoolsBuilder.

Returns:

the new builder

newResourcePoolsBuilder

public static ResourcePoolsBuilder newResourcePoolsBuilder(ResourcePools pools)

Convenience method to get a builder from an existing ResourcePools.

Parameters:

pools - the resource pools to build from

Returns:

a new builder with configuration matching the provided resource pools

heap

public static ResourcePoolsBuilder heap(long entries)

Creates a new ResourcePoolsBuilder with a heap pool sized in entries

Parameters:

entries - the maximum number of mappings to cache

Returns:

a new builder with a heap configuration

with

public ResourcePoolsBuilder with(ResourcePool resourcePool)

Add the ResourcePool of ResourceType in the returned builder.

Parameters:

resourcePool - the non-null resource pool to add

Returns:

a new builder with the added pool

Throws:

java.lang.IllegalArgumentException - if the set of resource pools already contains a pool for type

withReplacing

public ResourcePoolsBuilder withReplacing(ResourcePool resourcePool)

Add or replace the ResourcePool of ResourceType in the returned builder.

Parameters:

resourcePool - the non-null resource pool to add/replace

Returns:

a new builder with the added pool

with

public ResourcePoolsBuilder with(ResourceType<SizedResourcePool> type,
                                 long size,
                                 ResourceUnit unit,
                                 boolean persistent)

Add the ResourcePool of ResourceType in the returned builder.

Parameters:

type - the resource type

size - the pool size

unit - the pool size unit

persistent - if the pool is to be persistent

Returns:

a new builder with the added pool

Throws:

java.lang.IllegalArgumentException - if the set of resource pools already contains a pool for type

heap

public ResourcePoolsBuilder heap(long size,
                                 ResourceUnit unit)

Convenience method to add a heap pool.

Parameters:

size - the pool size

unit - the pool size unit

Returns:

a new builder with the added pool

Throws:

java.lang.IllegalArgumentException - if the set of resource pools already contains a heap resource

sharedHeap

public ResourcePoolsBuilder sharedHeap()

Informs the cache manager that an existing heap shared pool, defined on the cache manager, should be used for the cache's on-heap caching requirements.

Returns:

a new builder with the added pool

offheap

public ResourcePoolsBuilder offheap(long size,
                                    MemoryUnit unit)

Convenience method to add an offheap pool.

Parameters:

size - the pool size

unit - the pool size unit

Returns:

a new builder with the added pool

Throws:

java.lang.IllegalArgumentException - if the set of resource pools already contains an offheap resource

sharedOffheap

public ResourcePoolsBuilder sharedOffheap()

Informs the cache manager that an existing offheap shared pool, defined on the cache manager, should be used for the cache's offheap caching requirements.

Returns:

a new builder with the added pool

disk

public ResourcePoolsBuilder disk(long size,
                                 MemoryUnit unit)

Convenience method to add a non persistent disk pool.

Parameters:

size - the pool size

unit - the pool size unit

Returns:

a new builder with the added pool

Throws:

java.lang.IllegalArgumentException - if the set of resource pools already contains a disk resource

disk

public ResourcePoolsBuilder disk(long size,
                                 MemoryUnit unit,
                                 boolean persistent)

Convenience method to add a disk pool specifying persistence.

Parameters:

size - the pool size

unit - the pool size unit

persistent - if the pool is persistent or not

Returns:

a new builder with the added pool

Throws:

java.lang.IllegalArgumentException - if the set of resource pools already contains a disk resource

sharedDisk

public ResourcePoolsBuilder sharedDisk()

Informs the cache manager that an existing disk shared pool, defined on the cache manager, should be used for the cache's disk caching requirements.

Returns:

a new builder with the added pool

shared

public ResourcePoolsBuilder shared(ResourceType<?> type,
                                   boolean persistent)

shared

public ResourcePoolsBuilder shared(ResourceType<?> type)

build

public ResourcePools build()

Builds the ResourcePools based on this builder's configuration.

Specified by:

build in interface Builder<ResourcePools>

Returns:

the resource pools