com.hazelcast.config

Class CacheConfig<K,V>

java.lang.Object

com.hazelcast.config.CacheConfig<K,V>

Type Parameters:

K -

V -

All Implemented Interfaces:

DataSerializable, Serializable, javax.cache.configuration.CompleteConfiguration<K,V>, javax.cache.configuration.Configuration<K,V>

Direct Known Subclasses:

CacheConfigReadOnly

public class CacheConfig<K,V>
extends Object

Contains all the configuration for the ICache

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.cache.configuration.Factory<javax.cache.integration.CacheLoader<K,V>>	cacheLoaderFactory The Factory for the CacheLoader.
protected javax.cache.configuration.Factory<javax.cache.integration.CacheWriter<? super K,? super V>>	cacheWriterFactory The Factory for the CacheWriter.
static int	DEFAULT_BACKUP_COUNT The number of default backup counter
static EvictionPolicy	DEFAULT_EVICTION_POLICY Default Eviction Policy.
static InMemoryFormat	DEFAULT_IN_MEMORY_FORMAT Default InMemory Format.
protected javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy>	expiryPolicyFactory The Factory for the ExpiryPolicy.
protected boolean	isManagementEnabled Whether management is enabled
protected boolean	isReadThrough A flag indicating if "read-through" mode is required.
protected boolean	isStatisticsEnabled A flag indicating if statistics gathering is enabled.
protected boolean	isStoreByValue A flag indicating if the cache will be store-by-value or store-by-reference.
protected boolean	isWriteThrough A flag indicating if "write-through" mode is required.
protected Class<K>	keyType The type of keys for Caches configured with this Configuration.
protected Set<javax.cache.configuration.CacheEntryListenerConfiguration<K,V>>	listenerConfigurations The CacheEntryListenerConfigurations for the Configuration.
static int	MAX_BACKUP_COUNT The number of maximum backup counter
static int	MIN_BACKUP_COUNT The number of minimum backup counter
protected Class<V>	valueType The type of values for Caches configured with this Configuration.

Constructor Summary

Constructors

Constructor and Description
CacheConfig()
CacheConfig(javax.cache.configuration.CompleteConfiguration<K,V> configuration)

Method Summary

Methods

Modifier and Type	Method and Description
javax.cache.configuration.CompleteConfiguration<K,V>	addCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration) Add a configuration for a CacheEntryListener.
protected Set<javax.cache.configuration.CacheEntryListenerConfiguration<K,V>>	createConcurrentSet()
boolean	equals(Object o)
CacheConfigReadOnly<K,V>	getAsReadOnly() Immutable CacheConfig instance
int	getAsyncBackupCount()
int	getBackupCount()
Iterable<javax.cache.configuration.CacheEntryListenerConfiguration<K,V>>	getCacheEntryListenerConfigurations()
javax.cache.configuration.Factory<javax.cache.integration.CacheLoader<K,V>>	getCacheLoaderFactory()
javax.cache.configuration.Factory<javax.cache.integration.CacheWriter<? super K,? super V>>	getCacheWriterFactory()
EvictionPolicy	getEvictionPolicy()
javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy>	getExpiryPolicyFactory()
InMemoryFormat	getInMemoryFormat()
Class<K>	getKeyType()
String	getManagerPrefix()
String	getName()
String	getNameWithPrefix()
NearCacheConfig	getNearCacheConfig()
int	getTotalBackupCount()
String	getUriString()
Class<V>	getValueType()
int	hashCode()
boolean	isManagementEnabled()
boolean	isReadThrough()
boolean	isStatisticsEnabled()
boolean	isStoreByValue()
boolean	isWriteThrough()
void	readData(ObjectDataInput in) Reads fields from the input stream
javax.cache.configuration.CompleteConfiguration<K,V>	removeCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration) Remove a configuration for a CacheEntryListener.
CacheConfig<K,V>	setAsyncBackupCount(int asyncBackupCount) Number of asynchronous backups.
CacheConfig<K,V>	setBackupCount(int backupCount) Number of synchronous backups.
CacheConfig<K,V>	setEvictionPolicy(EvictionPolicy evictionPolicy)
CacheConfig<K,V>	setInMemoryFormat(InMemoryFormat inMemoryFormat) Data type that will be used for storing records.
javax.cache.configuration.CompleteConfiguration<K,V>	setManagementEnabled(boolean enabled) Sets whether management is enabled on a cache.
CacheConfig<K,V>	setManagerPrefix(String managerPrefix)
CacheConfig<K,V>	setName(String name)
CacheConfig	setNearCacheConfig(NearCacheConfig nearCacheConfig)
javax.cache.configuration.CompleteConfiguration<K,V>	setStatisticsEnabled(boolean enabled) Sets whether statistics gathering is enabled on a cache.
javax.cache.configuration.CompleteConfiguration<K,V>	setStoreByValue(boolean storeByValue) Set if a configured cache should use store-by-value or store-by-reference semantics.
javax.cache.configuration.CompleteConfiguration<K,V>	setTypes(Class<K> keyType, Class<V> valueType) Sets the expected type of keys and values for a Cache configured with this Configuration.
CacheConfig<K,V>	setUriString(String uriString)
void	writeData(ObjectDataOutput out) Writes object fields to output stream

Methods inherited from class java.lang.Object

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

Field Detail

MIN_BACKUP_COUNT

public static final int MIN_BACKUP_COUNT

The number of minimum backup counter

See Also:

Constant Field Values

MAX_BACKUP_COUNT

public static final int MAX_BACKUP_COUNT

The number of maximum backup counter

See Also:

Constant Field Values

DEFAULT_BACKUP_COUNT

public static final int DEFAULT_BACKUP_COUNT

The number of default backup counter

See Also:

Constant Field Values

DEFAULT_IN_MEMORY_FORMAT

public static final InMemoryFormat DEFAULT_IN_MEMORY_FORMAT

Default InMemory Format.

DEFAULT_EVICTION_POLICY

public static final EvictionPolicy DEFAULT_EVICTION_POLICY

Default Eviction Policy.

listenerConfigurations

protected Set<javax.cache.configuration.CacheEntryListenerConfiguration<K,V>> listenerConfigurations

The CacheEntryListenerConfigurations for the Configuration.

keyType

protected Class<K> keyType

The type of keys for Caches configured with this Configuration.

valueType

protected Class<V> valueType

The type of values for Caches configured with this Configuration.

cacheLoaderFactory

protected javax.cache.configuration.Factory<javax.cache.integration.CacheLoader<K,V>> cacheLoaderFactory

The Factory for the CacheLoader.

cacheWriterFactory

protected javax.cache.configuration.Factory<javax.cache.integration.CacheWriter<? super K,? super V>> cacheWriterFactory

The Factory for the CacheWriter.

expiryPolicyFactory

protected javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy> expiryPolicyFactory

The Factory for the ExpiryPolicy.

isReadThrough

protected boolean isReadThrough

A flag indicating if "read-through" mode is required.

isWriteThrough

protected boolean isWriteThrough

A flag indicating if "write-through" mode is required.

isStatisticsEnabled

protected boolean isStatisticsEnabled

A flag indicating if statistics gathering is enabled.

isStoreByValue

protected boolean isStoreByValue

A flag indicating if the cache will be store-by-value or store-by-reference.

isManagementEnabled

protected boolean isManagementEnabled

Whether management is enabled

Constructor Detail

CacheConfig

public CacheConfig()

CacheConfig

public CacheConfig(javax.cache.configuration.CompleteConfiguration<K,V> configuration)

Method Detail

getAsReadOnly

public CacheConfigReadOnly<K,V> getAsReadOnly()

Immutable CacheConfig instance

getName

public String getName()

Returns:

the name

setName

public CacheConfig<K,V> setName(String name)

Parameters:

name - the name to set

getManagerPrefix

public String getManagerPrefix()

Returns:

the managerPrefix

setManagerPrefix

public CacheConfig<K,V> setManagerPrefix(String managerPrefix)

getUriString

public String getUriString()

setUriString

public CacheConfig<K,V> setUriString(String uriString)

getNameWithPrefix

public String getNameWithPrefix()

Returns:

the name with manager scope prefix

getBackupCount

public int getBackupCount()

Returns:

the backupCount

See Also:

getAsyncBackupCount()

setBackupCount

public CacheConfig<K,V> setBackupCount(int backupCount)

Number of synchronous backups. If 1 is set as the backup-count for example, then all entries of the map will be copied to another JVM for fail-safety. 0 means no sync backup.

Parameters:

backupCount - the backupCount to set

See Also:

setAsyncBackupCount(int)

getAsyncBackupCount

public int getAsyncBackupCount()

Returns:

the asyncBackupCount

See Also:

setBackupCount(int)

setAsyncBackupCount

public CacheConfig<K,V> setAsyncBackupCount(int asyncBackupCount)

Number of asynchronous backups. 0 means no backup.

Parameters:

asyncBackupCount - the asyncBackupCount to set

See Also:

setBackupCount(int)

getTotalBackupCount

public int getTotalBackupCount()

getEvictionPolicy

public EvictionPolicy getEvictionPolicy()

Returns:

the evictionPolicy

setEvictionPolicy

public CacheConfig<K,V> setEvictionPolicy(EvictionPolicy evictionPolicy)

Parameters:

evictionPolicy - the evictionPolicy to set

getNearCacheConfig

public NearCacheConfig getNearCacheConfig()

setNearCacheConfig

public CacheConfig setNearCacheConfig(NearCacheConfig nearCacheConfig)

getInMemoryFormat

public InMemoryFormat getInMemoryFormat()

Returns:

data type that will be used for storing records.

setInMemoryFormat

public CacheConfig<K,V> setInMemoryFormat(InMemoryFormat inMemoryFormat)

Data type that will be used for storing records. Possible values: BINARY (default): keys and values will be stored as binary data OBJECT : values will be stored in their object forms

Parameters:

inMemoryFormat - the record type to set

Throws:

IllegalArgumentException - if inMemoryFormat is null.

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Parameters:

out - output

Throws:

IOException

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Parameters:

in - input

Throws:

IOException

hashCode

public int hashCode()

equals

public boolean equals(Object o)

addCacheEntryListenerConfiguration

public javax.cache.configuration.CompleteConfiguration<K,V> addCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)

Add a configuration for a CacheEntryListener.

Parameters:

cacheEntryListenerConfiguration - the CacheEntryListenerConfiguration

Returns:

the CacheConfig

Throws:

IllegalArgumentException - is the same CacheEntryListenerConfiguration is used more than once

removeCacheEntryListenerConfiguration

public javax.cache.configuration.CompleteConfiguration<K,V> removeCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration)

Remove a configuration for a CacheEntryListener.

Parameters:

cacheEntryListenerConfiguration - the CacheEntryListenerConfiguration to remove

Returns:

the CacheConfig

getCacheEntryListenerConfigurations

public Iterable<javax.cache.configuration.CacheEntryListenerConfiguration<K,V>> getCacheEntryListenerConfigurations()

Specified by:

getCacheEntryListenerConfigurations in interface javax.cache.configuration.CompleteConfiguration<K,V>

isReadThrough

public boolean isReadThrough()

Specified by:

isReadThrough in interface javax.cache.configuration.CompleteConfiguration<K,V>

isWriteThrough

public boolean isWriteThrough()

Specified by:

isWriteThrough in interface javax.cache.configuration.CompleteConfiguration<K,V>

isStatisticsEnabled

public boolean isStatisticsEnabled()

Specified by:

isStatisticsEnabled in interface javax.cache.configuration.CompleteConfiguration<K,V>

setStatisticsEnabled

public javax.cache.configuration.CompleteConfiguration<K,V> setStatisticsEnabled(boolean enabled)

Sets whether statistics gathering is enabled on a cache.

Statistics may be enabled or disabled at runtime via CacheManager.enableStatistics(String, boolean).

Parameters:

enabled - true to enable statistics, false to disable.

Returns:

the CacheConfig

isManagementEnabled

public boolean isManagementEnabled()

Specified by:

isManagementEnabled in interface javax.cache.configuration.CompleteConfiguration<K,V>

setManagementEnabled

public javax.cache.configuration.CompleteConfiguration<K,V> setManagementEnabled(boolean enabled)

Sets whether management is enabled on a cache.

Management may be enabled or disabled at runtime via CacheManager.enableManagement(String, boolean).

Parameters:

enabled - true to enable statistics, false to disable.

Returns:

the CacheConfig

getCacheLoaderFactory

public javax.cache.configuration.Factory<javax.cache.integration.CacheLoader<K,V>> getCacheLoaderFactory()

Specified by:

getCacheLoaderFactory in interface javax.cache.configuration.CompleteConfiguration<K,V>

getCacheWriterFactory

public javax.cache.configuration.Factory<javax.cache.integration.CacheWriter<? super K,? super V>> getCacheWriterFactory()

Specified by:

getCacheWriterFactory in interface javax.cache.configuration.CompleteConfiguration<K,V>

getExpiryPolicyFactory

public javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy> getExpiryPolicyFactory()

Specified by:

getExpiryPolicyFactory in interface javax.cache.configuration.CompleteConfiguration<K,V>

getKeyType

public Class<K> getKeyType()

Specified by:

getKeyType in interface javax.cache.configuration.Configuration<K,V>

getValueType

public Class<V> getValueType()

Specified by:

getValueType in interface javax.cache.configuration.Configuration<K,V>

setTypes

public javax.cache.configuration.CompleteConfiguration<K,V> setTypes(Class<K> keyType,
                                                            Class<V> valueType)

Sets the expected type of keys and values for a Cache configured with this Configuration. Setting both to Object.class means type-safety checks are not required.

This is used by CacheManager to ensure that the key and value types are the same as those configured for the Cache prior to returning a requested cache from this method.

Implementations may further perform type checking on mutative cache operations and throw a ClassCastException if these checks fail.

Parameters:

keyType - the expected key type

valueType - the expected value type

Returns:

the CacheConfig

Throws:

NullPointerException - should the key or value type be null

See Also:

CacheManager.getCache(String, Class, Class)

isStoreByValue

public boolean isStoreByValue()

Specified by:

isStoreByValue in interface javax.cache.configuration.Configuration<K,V>

setStoreByValue

public javax.cache.configuration.CompleteConfiguration<K,V> setStoreByValue(boolean storeByValue)

Set if a configured cache should use store-by-value or store-by-reference semantics.

Parameters:

storeByValue - true if store-by-value is required, false for store-by-reference

Returns:

the CacheConfig

createConcurrentSet

protected Set<javax.cache.configuration.CacheEntryListenerConfiguration<K,V>> createConcurrentSet()