org.infinispan.configuration.cache

Class MemoryConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.MemoryConfigurationBuilder

All Implemented Interfaces:

BaseConfigurationInfo, Builder<MemoryConfiguration>, ConfigurationBuilderInfo, ConfigurationChildBuilder

public class MemoryConfigurationBuilder
extends java.lang.Object
implements Builder<MemoryConfiguration>, ConfigurationBuilderInfo

Controls the data container for the cache.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationBuilder	builder

Method Summary

Modifier and Type	Method and Description
int	addressCount() How many address pointers are configured for the off heap storage.
MemoryConfigurationBuilder	addressCount(int addressCount) Configuration setting when using off-heap that defines how many address pointers there are.
AttributeSet	attributes()
Configuration	build()
ClusteringConfigurationBuilder	clustering()
CompatibilityModeConfigurationBuilder	compatibility() Deprecated.
MemoryConfiguration	create() Create the configuration bean
CustomInterceptorsConfigurationBuilder	customInterceptors()
DataContainerConfigurationBuilder	dataContainer()
DeadlockDetectionConfigurationBuilder	deadlockDetection()
EncodingConfigurationBuilder	encoding()
EvictionConfigurationBuilder	eviction()
EvictionStrategy	evictionStrategy() The configured eviction strategy, please see evictionStrategy(EvictionStrategy).
MemoryConfigurationBuilder	evictionStrategy(EvictionStrategy strategy) Sets the eviction strategy which can be: NONE - no eviction will take place MANUAL - no eviction will take place automatically, but user is assumed to manually call evict REMOVE - eviction will remove entries to make room for new entries to be inserted EXCEPTION - eviction will not take place, but instead an exception will be thrown to ensure container doesn't grow too large The eviction strategy NONE and MANUAL are essentially the same except that MANUAL does not warn the user when passivation is enabled.
EvictionType	evictionType() The configured eviction type, please see evictionType(EvictionType).
MemoryConfigurationBuilder	evictionType(EvictionType type) Sets the eviction type which can either be COUNT - entries will be evicted when the number of entries exceeds the size(long) MEMORY - entries will be evicted when the approximate combined size of all values exceeds the size(long) Cache size is guaranteed not to exceed upper limit specified by size.
ExpirationConfigurationBuilder	expiration()
protected ConfigurationBuilder	getBuilder()
ElementDefinition	getElementDefinition()
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
JMXStatisticsConfigurationBuilder	jmxStatistics()
LockingConfigurationBuilder	locking()
MemoryConfigurationBuilder	memory()
PersistenceConfigurationBuilder	persistence()
MemoryConfigurationBuilder	read(MemoryConfiguration template) Reads the configuration from an already created configuration bean into this builder.
SecurityConfigurationBuilder	security()
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
long	size() The configured eviction size, please see size(long).
MemoryConfigurationBuilder	size(long size) Defines the maximum size before eviction occurs.
StorageType	storageType() The underlying storage type for this configuration
MemoryConfigurationBuilder	storageType(StorageType storageType) Set the StorageType to determine how the data is stored in the data container.
StoreAsBinaryConfigurationBuilder	storeAsBinary() Deprecated.
ConfigurationChildBuilder	template(boolean template)
java.lang.String	toString()
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
void	validate() Validate the data in this builder before building the configuration bean
void	validate(GlobalConfiguration globalConfig)
VersioningConfigurationBuilder	versioning()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commons.configuration.ConfigurationBuilderInfo

getBuilderInfo, getChildrenInfo, getNewBuilderInfo

Field Detail

builder

protected final ConfigurationBuilder builder

Method Detail

storageType

public MemoryConfigurationBuilder storageType(StorageType storageType)

Set the StorageType to determine how the data is stored in the data container.

Parameters:

storageType - the storage type of the underlying data

Returns:

this configuration builder

storageType

public StorageType storageType()

The underlying storage type for this configuration

Returns:

the configured storage type

size

public MemoryConfigurationBuilder size(long size)

Defines the maximum size before eviction occurs. See evictionType(EvictionType) for more details on the size is interpreted. If evictionStrategy(EvictionStrategy) has not been invoked, this will set the strategy to EvictionStrategy.REMOVE.

Parameters:

size - the maximum size for the container

attributes

public AttributeSet attributes()

Specified by:

attributes in interface BaseConfigurationInfo

Returns:

the AttributeSet declared by the configuration.

getElementDefinition

public ElementDefinition getElementDefinition()

Specified by:

getElementDefinition in interface BaseConfigurationInfo

Returns:

the ElementDefinition of the configuration.

size

public long size()

The configured eviction size, please see size(long).

Returns:

the configured evicted size

evictionType

public MemoryConfigurationBuilder evictionType(EvictionType type)

Sets the eviction type which can either be

• COUNT - entries will be evicted when the number of entries exceeds the size(long)
• MEMORY - entries will be evicted when the approximate combined size of all values exceeds the size(long)

Cache size is guaranteed not to exceed upper limit specified by size.

Parameters:

type -

evictionType

public EvictionType evictionType()

The configured eviction type, please see evictionType(EvictionType).

Returns:

the configured eviction type

evictionStrategy

public MemoryConfigurationBuilder evictionStrategy(EvictionStrategy strategy)

Sets the eviction strategy which can be:

• NONE - no eviction will take place
• MANUAL - no eviction will take place automatically, but user is assumed to manually call evict
• REMOVE - eviction will remove entries to make room for new entries to be inserted
• EXCEPTION - eviction will not take place, but instead an exception will be thrown to ensure container doesn't grow too large

The eviction strategy NONE and MANUAL are essentially the same except that MANUAL does not warn the user when passivation is enabled.

Parameters:

strategy - the strategy to set

Returns:

this

evictionStrategy

public EvictionStrategy evictionStrategy()

The configured eviction strategy, please see evictionStrategy(EvictionStrategy).

Returns:

the configured eviction stategy

addressCount

public MemoryConfigurationBuilder addressCount(int addressCount)

Configuration setting when using off-heap that defines how many address pointers there are. This number will be rounded up to the next power of two. This helps performance in that the more address pointers there are the less collisions there will be which improve performance of both read and write operations. This is only used when OFF_HEAP storage type is configured storageType(StorageType).

Parameters:

addressCount -

Returns:

this

addressCount

public int addressCount()

How many address pointers are configured for the off heap storage. See addressCount(int) for more information.

Returns:

the configured amount of address pointers

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<MemoryConfiguration>

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

create

public MemoryConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<MemoryConfiguration>

Returns:

read

public MemoryConfigurationBuilder read(MemoryConfiguration template)

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<MemoryConfiguration>

Parameters:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

template

public ConfigurationChildBuilder template(boolean template)

Specified by:

template in interface ConfigurationChildBuilder

simpleCache

public ConfigurationChildBuilder simpleCache(boolean simpleCache)

Specified by:

simpleCache in interface ConfigurationChildBuilder

simpleCache

public boolean simpleCache()

Specified by:

simpleCache in interface ConfigurationChildBuilder

clustering

public ClusteringConfigurationBuilder clustering()

Specified by:

clustering in interface ConfigurationChildBuilder

customInterceptors

public CustomInterceptorsConfigurationBuilder customInterceptors()

Specified by:

customInterceptors in interface ConfigurationChildBuilder

dataContainer

public DataContainerConfigurationBuilder dataContainer()

Specified by:

dataContainer in interface ConfigurationChildBuilder

deadlockDetection

public DeadlockDetectionConfigurationBuilder deadlockDetection()

Specified by:

deadlockDetection in interface ConfigurationChildBuilder

encoding

public EncodingConfigurationBuilder encoding()

Specified by:

encoding in interface ConfigurationChildBuilder

eviction

public EvictionConfigurationBuilder eviction()

Specified by:

eviction in interface ConfigurationChildBuilder

expiration

public ExpirationConfigurationBuilder expiration()

Specified by:

expiration in interface ConfigurationChildBuilder

indexing

public IndexingConfigurationBuilder indexing()

Specified by:

indexing in interface ConfigurationChildBuilder

invocationBatching

public InvocationBatchingConfigurationBuilder invocationBatching()

Specified by:

invocationBatching in interface ConfigurationChildBuilder

jmxStatistics

public JMXStatisticsConfigurationBuilder jmxStatistics()

Specified by:

jmxStatistics in interface ConfigurationChildBuilder

persistence

public PersistenceConfigurationBuilder persistence()

Specified by:

persistence in interface ConfigurationChildBuilder

locking

public LockingConfigurationBuilder locking()

Specified by:

locking in interface ConfigurationChildBuilder

security

public SecurityConfigurationBuilder security()

Specified by:

security in interface ConfigurationChildBuilder

storeAsBinary

@Deprecated
public StoreAsBinaryConfigurationBuilder storeAsBinary()

Deprecated.

Specified by:

storeAsBinary in interface ConfigurationChildBuilder

transaction

public TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface ConfigurationChildBuilder

versioning

public VersioningConfigurationBuilder versioning()

Specified by:

versioning in interface ConfigurationChildBuilder

unsafe

public UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface ConfigurationChildBuilder

sites

public SitesConfigurationBuilder sites()

Specified by:

sites in interface ConfigurationChildBuilder

compatibility

@Deprecated
public CompatibilityModeConfigurationBuilder compatibility()

Deprecated.

Specified by:

compatibility in interface ConfigurationChildBuilder

memory

public MemoryConfigurationBuilder memory()

Specified by:

memory in interface ConfigurationChildBuilder

getBuilder

protected ConfigurationBuilder getBuilder()

build

public Configuration build()

Specified by:

build in interface ConfigurationChildBuilder