Class ContainerMemoryConfigurationBuilder

java.lang.Object

org.infinispan.configuration.global.AbstractGlobalConfigurationBuilder

org.infinispan.configuration.global.ContainerMemoryConfigurationBuilder

All Implemented Interfaces:

Builder<ContainerMemoryConfiguration>, GlobalConfigurationChildBuilder

public class ContainerMemoryConfigurationBuilder
extends AbstractGlobalConfigurationBuilder
implements Builder<ContainerMemoryConfiguration>

Configures the container memory which allows for a shared memory space used by multiple caches that can be bounded so when the limit is surpassed an entry is evicted to ensure memory does not grow too much. The memory container supports both count based (number of entries) and size based (how much approximate memory in bytes) eviction methods.

Since:

16.1

Author:

William Burns

Method Summary

Modifier and Type	Method	Description
AttributeSet	attributes()
ContainerMemoryConfiguration	create()	Create the configuration bean
long	maxCount()	The currently configured max count.
ContainerMemoryConfigurationBuilder	maxCount(long count)	Defines the maximum number of entries for the container memory.
String	maxSize()	The currently configured max size.
ContainerMemoryConfigurationBuilder	maxSize(String size)	Defines the maximum size of the container memory.
ContainerMemoryConfigurationBuilder	read(ContainerMemoryConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
String	toString()
void	validate()	Validate the data in this builder before building the configuration bean

Methods inherited from class AbstractGlobalConfigurationBuilder

addModule, asyncThreadPool, blockingThreadPool, build, clearModules, containerMemoryConfiguration, defaultCacheName, expirationThreadPool, getGlobalConfig, globalState, jmx, listenerThreadPool, metrics, module, modules, nonBlockingThreadPool, persistenceThreadPool, security, serialization, shutdown, tracing, transport

Methods inherited from class Object

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

Methods inherited from interface Builder

read, reset

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<ContainerMemoryConfiguration>

maxSize

public ContainerMemoryConfigurationBuilder maxSize(String size)

Defines the maximum size of the container memory.

Parameters:

size - The size of the memory container in bytes. This can be a number or a string ending with KB, MB, GB, TB, PB (e.g. "10MB").

Returns:

this, for method chaining

maxSize

public String maxSize()

The currently configured max size.

Returns:

The size as a string.

maxCount

public ContainerMemoryConfigurationBuilder maxCount(long count)

Defines the maximum number of entries for the container memory.

Parameters:

count - The maximum number of entries.

Returns:

this, for method chaining

maxCount

public long maxCount()

The currently configured max count.

Returns:

The maximum number of entries.

validate

public void validate()

Description copied from interface: Builder

Validate the data in this builder before building the configuration bean

Specified by:

validate in interface Builder<ContainerMemoryConfiguration>

create

public ContainerMemoryConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<ContainerMemoryConfiguration>

Returns:

read

public ContainerMemoryConfigurationBuilder read(ContainerMemoryConfiguration template,
 Combine combine)

Description copied from interface: Builder

Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration

Specified by:

read in interface Builder<ContainerMemoryConfiguration>

Parameters:

template - the configuration from which to "clone" this config if needed.

combine - the way attributes and children of this instance and the template should be combined.

toString

public String toString()

Overrides:

toString in class Object