Class MemoryConfiguration

java.lang.Object

org.infinispan.commons.configuration.attributes.ConfigurationElement<MemoryConfiguration>

org.infinispan.configuration.cache.MemoryConfiguration

All Implemented Interfaces:

Matchable<MemoryConfiguration>, Updatable<MemoryConfiguration>

public class MemoryConfiguration
extends ConfigurationElement<MemoryConfiguration>

Controls the memory storage configuration for the cache.

Author:

William Burns

Field Summary

Fields

Modifier and Type	Field	Description
static final AttributeDefinition<String>	EVICTION_CONTAINER
static final AttributeDefinition<Long>	MAX_COUNT
static final AttributeDefinition<String>	MAX_SIZE
static final AttributeDefinition<StorageType>	STORAGE
static final AttributeDefinition<EvictionStrategy>	WHEN_FULL

Fields inherited from class ConfigurationElement

attributes, CHILDLESS, children, element, repeated

Method Summary

Modifier and Type	Method	Description
String	evictionContainer()	The name of the eviction container used for eviction purposes.
boolean	isEvictionEnabled()	Returns whether remove eviction is in use
boolean	isOffHeap()
long	maxCount()
void	maxCount(long maxCount)
String	maxSize()
void	maxSize(long maxSize)
void	maxSize(String maxSize)
long	maxSizeBytes()
StorageType	storage()	Storage type to use for the data container
EvictionStrategy	whenFull()	The configured eviction strategy

Methods inherited from class ConfigurationElement

attributes, child, children, children, elementName, equals, extractAttributes, findAttribute, hashCode, isModified, list, matches, matches, matches, toString, update, update, update, validateUpdate, validateUpdate, validateUpdate, write

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

STORAGE

public static final AttributeDefinition<StorageType> STORAGE

MAX_SIZE

public static final AttributeDefinition<String> MAX_SIZE

MAX_COUNT

public static final AttributeDefinition<Long> MAX_COUNT

WHEN_FULL

public static final AttributeDefinition<EvictionStrategy> WHEN_FULL

EVICTION_CONTAINER

public static final AttributeDefinition<String> EVICTION_CONTAINER

Method Details

isOffHeap

public boolean isOffHeap()

Returns:

true if the storage is off-heap

maxSizeBytes

public long maxSizeBytes()

Returns:

The max size in bytes or -1 if not configured.

maxSize

public String maxSize()

maxSize

public void maxSize(String maxSize)

maxSize

public void maxSize(long maxSize)

maxCount

public long maxCount()

Returns:

the max number of entries in memory or -1 if not configured.

maxCount

public void maxCount(long maxCount)

storage

public StorageType storage()

Storage type to use for the data container

Returns:

The memory StorageType.

whenFull

public EvictionStrategy whenFull()

The configured eviction strategy

Returns:

The configured EvictionStrategy.

isEvictionEnabled

public boolean isEvictionEnabled()

Returns whether remove eviction is in use

evictionContainer

public String evictionContainer()

The name of the eviction container used for eviction purposes. Note that when is non null, no other values should be utilized.

Returns:

the eviction container to use for shared eviction