Package org.infinispan.configuration.cache

Class MemoryConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.MemoryConfigurationBuilder

All Implemented Interfaces:

org.infinispan.commons.configuration.BaseConfigurationInfo, org.infinispan.commons.configuration.Builder<MemoryConfiguration>, org.infinispan.commons.configuration.ConfigurationBuilderInfo, ConfigurationChildBuilder

public class MemoryConfigurationBuilder
extends Object
implements org.infinispan.commons.configuration.Builder<MemoryConfiguration>, org.infinispan.commons.configuration.ConfigurationBuilderInfo

Controls the data container for the cache.

Author:

William Burns

Field Summary

Fields

Modifier and Type	Field	Description
protected ConfigurationBuilder	builder

Method Summary

Modifier and Type	Method	Description
org.infinispan.commons.configuration.attributes.AttributeSet	attributes()
Configuration	build()
ClusteringConfigurationBuilder	clustering()
MemoryConfiguration	create()
CustomInterceptorsConfigurationBuilder	customInterceptors()	Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
EncodingConfigurationBuilder	encoding()
EvictionStrategy	evictionStrategy()	Deprecated. Since 11.0, use whenFull() instead.
MemoryConfigurationBuilder	evictionStrategy(EvictionStrategy strategy)	Deprecated. Since 11.0, use whenFull(EvictionStrategy) instead.
EvictionType	evictionType()	Deprecated. since 11.0, @see evictionType(EvictionType)
MemoryConfigurationBuilder	evictionType(EvictionType type)	Deprecated. since 11.0, use maxCount(long) or maxSize(String) to define data container bounds by size or by count.
ExpirationConfigurationBuilder	expiration()
protected ConfigurationBuilder	getBuilder()
org.infinispan.commons.configuration.ConfigurationBuilderInfo	getBuilderInfo(String name, String qualifier)
Collection<org.infinispan.commons.configuration.ConfigurationBuilderInfo>	getChildrenInfo()
org.infinispan.commons.configuration.elements.ElementDefinition<?>	getElementDefinition()
IndexingConfigurationBuilder	indexing()
InvocationBatchingConfigurationBuilder	invocationBatching()
LockingConfigurationBuilder	locking()
long	maxCount()
MemoryConfigurationBuilder	maxCount(long count)
String	maxSize()
MemoryConfigurationBuilder	maxSize(String size)
MemoryConfigurationBuilder	memory()
PersistenceConfigurationBuilder	persistence()
MemoryConfigurationBuilder	read(MemoryConfiguration template)
SecurityConfigurationBuilder	security()
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
long	size()	Deprecated. Since 11.0, use either maxSize() or maxCount().
MemoryConfigurationBuilder	size(long size)	Deprecated. Since 11.0, use maxSize(String) to define the size in bytes or maxCount(long) to define the number of entries.
StatisticsConfigurationBuilder	statistics()
StorageType	storage()
MemoryConfigurationBuilder	storage(StorageType storageType)
StorageType	storageType()	Deprecated. Since 11.0, use storage() instead.
MemoryConfigurationBuilder	storageType(StorageType storageType)	Deprecated. Since 11.0, use storage(StorageType) instead.
ConfigurationChildBuilder	template(boolean template)
String	toString()
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
void	validate()
void	validate(GlobalConfiguration globalConfig)
EvictionStrategy	whenFull()
MemoryConfigurationBuilder	whenFull(EvictionStrategy strategy)

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

getNewBuilderInfo

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

jmxStatistics

Field Detail

builder

protected final ConfigurationBuilder builder

Method Detail

getChildrenInfo

public Collection<org.infinispan.commons.configuration.ConfigurationBuilderInfo> getChildrenInfo()

Specified by:

getChildrenInfo in interface org.infinispan.commons.configuration.ConfigurationBuilderInfo

attributes

public org.infinispan.commons.configuration.attributes.AttributeSet attributes()

Specified by:

attributes in interface org.infinispan.commons.configuration.BaseConfigurationInfo

storageType

@Deprecated
public MemoryConfigurationBuilder storageType(StorageType storageType)

Deprecated.

Since 11.0, use storage(StorageType) instead.

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

storage

public MemoryConfigurationBuilder storage(StorageType storageType)

maxSize

public MemoryConfigurationBuilder maxSize(String size)

maxSize

public String maxSize()

maxCount

public MemoryConfigurationBuilder maxCount(long count)

maxCount

public long maxCount()

storageType

@Deprecated
public StorageType storageType()

Deprecated.

Since 11.0, use storage() instead.

The underlying storage type for this configuration

Returns:

the configured storage type

storage

public StorageType storage()

size

@Deprecated
public MemoryConfigurationBuilder size(long size)

Deprecated.

Since 11.0, use maxSize(String) to define the size in bytes or maxCount(long) to define the number of entries.

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

getElementDefinition

public org.infinispan.commons.configuration.elements.ElementDefinition<?> getElementDefinition()

Specified by:

getElementDefinition in interface org.infinispan.commons.configuration.BaseConfigurationInfo

size

@Deprecated
public long size()

Deprecated.

Since 11.0, use either maxSize() or maxCount().

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

Returns:

the configured evicted size

evictionType

@Deprecated
public MemoryConfigurationBuilder evictionType(EvictionType type)

Deprecated.

since 11.0, use maxCount(long) or maxSize(String) to define data container bounds by size or by count.

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

@Deprecated
public EvictionType evictionType()

Deprecated.

since 11.0, @see evictionType(EvictionType)

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

Returns:

the configured eviction type

evictionStrategy

@Deprecated
public MemoryConfigurationBuilder evictionStrategy(EvictionStrategy strategy)

Deprecated.

Since 11.0, use whenFull(EvictionStrategy) instead.

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

whenFull

public MemoryConfigurationBuilder whenFull(EvictionStrategy strategy)

whenFull

public EvictionStrategy whenFull()

evictionStrategy

@Deprecated
public EvictionStrategy evictionStrategy()

Deprecated.

Since 11.0, use whenFull() instead.

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

Returns:

the configured eviction stategy

validate

public void validate()

Specified by:

validate in interface org.infinispan.commons.configuration.Builder<MemoryConfiguration>

validate

public void validate(GlobalConfiguration globalConfig)

Specified by:

validate in interface ConfigurationChildBuilder

create

public MemoryConfiguration create()

Specified by:

create in interface org.infinispan.commons.configuration.Builder<MemoryConfiguration>

read

public MemoryConfigurationBuilder read(MemoryConfiguration template)

Specified by:

read in interface org.infinispan.commons.configuration.Builder<MemoryConfiguration>

getBuilderInfo

public org.infinispan.commons.configuration.ConfigurationBuilderInfo getBuilderInfo(String name,
                                                                                    String qualifier)

Specified by:

getBuilderInfo in interface org.infinispan.commons.configuration.ConfigurationBuilderInfo

toString

public String toString()

Overrides:

toString in class 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

@Deprecated
public CustomInterceptorsConfigurationBuilder customInterceptors()

Deprecated.

Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors

Specified by:

customInterceptors in interface ConfigurationChildBuilder

encoding

public EncodingConfigurationBuilder encoding()

Specified by:

encoding 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

statistics

public StatisticsConfigurationBuilder statistics()

Specified by:

statistics 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

transaction

public TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface ConfigurationChildBuilder

unsafe

public UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface ConfigurationChildBuilder

sites

public SitesConfigurationBuilder sites()

Specified by:

sites 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