com.hazelcast.config

Class CacheConfigReadOnly<K,V>

java.lang.Object

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

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

Type Parameters:

K -

V -

All Implemented Interfaces:

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

public class CacheConfigReadOnly<K,V>
extends CacheConfig<K,V>

Contains the configuration for an ICache (read-only).

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.
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.
protected Class<V>	valueType The type of values for Caches configured with this Configuration.

Method Summary

Methods

Modifier and Type	Method and Description
CacheConfig<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()
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()
CacheEvictionConfig	getEvictionConfig() Gets the CacheEvictionConfig instance for eviction configuration of the cache config.
javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy>	getExpiryPolicyFactory()
Class<K>	getKeyType()
NearCacheConfig	getNearCacheConfig() Gets the NearCacheConfig of the cache config instance.
Class<V>	getValueType()
boolean	isManagementEnabled()
boolean	isReadThrough()
boolean	isStatisticsEnabled()
boolean	isStoreByValue()
boolean	isWriteThrough()
CacheConfig<K,V>	removeCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration) Remove a configuration for a CacheEntryListener.
CacheConfig<K,V>	setAsyncBackupCount(int asyncBackupCount) Sets the number of asynchronous backups of cache config.
CacheConfig<K,V>	setBackupCount(int backupCount) Sets the number of synchronous backups.
CacheConfiguration<K,V>	setCacheLoaderFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheLoader<K,V>> cacheLoaderFactory) Set the CacheLoader factory.
CacheConfiguration<K,V>	setCacheWriterFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheWriter<? super K,? super V>> cacheWriterFactory) Set the CacheWriter factory.
CacheConfig<K,V>	setEvictionConfig(CacheEvictionConfig evictionConfig) Sets the CacheEvictionConfig instance for eviction configuration of the cache config.
CacheConfiguration<K,V>	setExpiryPolicyFactory(javax.cache.configuration.Factory<? extends javax.cache.expiry.ExpiryPolicy> expiryPolicyFactory) Set the Factory for the ExpiryPolicy.
CacheConfig<K,V>	setInMemoryFormat(InMemoryFormat inMemoryFormat) Data type that will be used for storing records.
CacheConfig<K,V>	setManagementEnabled(boolean enabled) Sets whether management is enabled on a cache.
CacheConfig<K,V>	setManagerPrefix(String managerPrefix) Sets the manager prefix of the cache config.
CacheConfig<K,V>	setName(String name) Sets the name of the cache.
CacheConfig	setNearCacheConfig(NearCacheConfig nearCacheConfig) Sets the NearCacheConfig of the cache config instance.
CacheConfiguration<K,V>	setReadThrough(boolean isReadThrough) Set if read-through caching should be used.
CacheConfiguration<K,V>	setStatisticsEnabled(boolean enabled) Sets whether statistics gathering is enabled on a cache.
CacheConfig<K,V>	setStoreByValue(boolean storeByValue) Set if a configured cache should use store-by-value or store-by-reference semantics.
CacheConfig<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) Sets the URI string which is global identifier of the cache.
CacheConfiguration<K,V>	setWriteThrough(boolean isWriteThrough) Set if write-through caching should be used.

Methods inherited from class com.hazelcast.config.CacheConfig

equals, getAsReadOnly, getAsyncBackupCount, getBackupCount, getInMemoryFormat, getManagerPrefix, getName, getNameWithPrefix, getTotalBackupCount, getUriString, hashCode, readData, toString, writeData

Methods inherited from class java.lang.Object

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

Field Detail

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

Method Detail

getEvictionConfig

public CacheEvictionConfig getEvictionConfig()

Description copied from class: CacheConfig

Gets the CacheEvictionConfig instance for eviction configuration of the cache config.

Overrides:

getEvictionConfig in class CacheConfig<K,V>

Returns:

the CacheEvictionConfig instance for eviction configuration

addCacheEntryListenerConfiguration

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

Add a configuration for a CacheEntryListener.

Specified by:

addCacheEntryListenerConfiguration in interface CacheConfiguration<K,V>

Parameters:

cacheEntryListenerConfiguration - the CacheEntryListenerConfiguration

Returns:

the CacheConfig

removeCacheEntryListenerConfiguration

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

Remove a configuration for a CacheEntryListener.

Specified by:

removeCacheEntryListenerConfiguration in interface CacheConfiguration<K,V>

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>

setName

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

Description copied from class: CacheConfig

Sets the name of the cache.

Overrides:

setName in class CacheConfig<K,V>

Parameters:

name - the name of the cache to set

Returns:

current cache config instance

setManagerPrefix

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

Description copied from class: CacheConfig

Sets the manager prefix of the cache config.

Overrides:

setManagerPrefix in class CacheConfig<K,V>

Parameters:

managerPrefix - the manager prefix of the cache config to set

Returns:

current cache config instance

setUriString

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

Description copied from class: CacheConfig

Sets the URI string which is global identifier of the cache.

Overrides:

setUriString in class CacheConfig<K,V>

Parameters:

uriString - the URI string of the cache to set

Returns:

current cache config instance

setBackupCount

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

Description copied from class: CacheConfig

Sets the 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.

Overrides:

setBackupCount in class CacheConfig<K,V>

Parameters:

backupCount - the number of synchronous backups to set

Returns:

current cache config instance

See Also:

CacheConfig.setAsyncBackupCount(int)

setAsyncBackupCount

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

Description copied from class: CacheConfig

Sets the number of asynchronous backups of cache config. 0 means no backup.

Overrides:

setAsyncBackupCount in class CacheConfig<K,V>

Parameters:

asyncBackupCount - the number of asynchronous backups to set

Returns:

current cache config instance

See Also:

CacheConfig.setBackupCount(int)

setEvictionConfig

public CacheConfig<K,V> setEvictionConfig(CacheEvictionConfig evictionConfig)

Description copied from class: CacheConfig

Sets the CacheEvictionConfig instance for eviction configuration of the cache config.

Overrides:

setEvictionConfig in class CacheConfig<K,V>

Parameters:

evictionConfig - the CacheEvictionConfig instance for eviction configuration to set

Returns:

current cache config instance

setNearCacheConfig

public CacheConfig setNearCacheConfig(NearCacheConfig nearCacheConfig)

Description copied from class: CacheConfig

Sets the NearCacheConfig of the cache config instance.

Overrides:

setNearCacheConfig in class CacheConfig<K,V>

Parameters:

nearCacheConfig - the NearCacheConfig of the cache to set

Returns:

current cache config instance

setInMemoryFormat

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

Description copied from class: CacheConfig

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

Overrides:

setInMemoryFormat in class CacheConfig<K,V>

Parameters:

inMemoryFormat - the record type to set

Returns:

current cache config instance

setManagementEnabled

public CacheConfig<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).

Specified by:

setManagementEnabled in interface CacheConfiguration<K,V>

Parameters:

enabled - true to enable statistics, false to disable.

Returns:

the CacheConfig

setTypes

public CacheConfig<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.

Specified by:

setTypes in interface CacheConfiguration<K,V>

Parameters:

keyType - the expected key type

valueType - the expected value type

Returns:

the CacheConfig

See Also:

CacheManager.getCache(String, Class, Class)

setStoreByValue

public CacheConfig<K,V> setStoreByValue(boolean storeByValue)

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

Specified by:

setStoreByValue in interface CacheConfiguration<K,V>

Parameters:

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

Returns:

the CacheConfig

getNearCacheConfig

public NearCacheConfig getNearCacheConfig()

Description copied from class: CacheConfig

Gets the NearCacheConfig of the cache config instance.

Overrides:

getNearCacheConfig in class CacheConfig<K,V>

Returns:

the NearCacheConfig of the cache config instance

isReadThrough

public boolean isReadThrough()

Specified by:

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

setReadThrough

public CacheConfiguration<K,V> setReadThrough(boolean isReadThrough)

Description copied from interface: CacheConfiguration

Set if read-through caching should be used.

It is an invalid configuration to set this to true without specifying a CacheLoader Factory.

Specified by:

setReadThrough in interface CacheConfiguration<K,V>

Parameters:

isReadThrough - true if read-through is required

Returns:

the CacheConfiguration to permit fluent-style method calls

isWriteThrough

public boolean isWriteThrough()

Specified by:

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

setWriteThrough

public CacheConfiguration<K,V> setWriteThrough(boolean isWriteThrough)

Description copied from interface: CacheConfiguration

Set if write-through caching should be used.

It is an invalid configuration to set this to true without specifying a CacheWriter Factory.

Specified by:

setWriteThrough in interface CacheConfiguration<K,V>

Parameters:

isWriteThrough - true if write-through is required

Returns:

the CacheConfiguration to permit fluent-style method calls

isStatisticsEnabled

public boolean isStatisticsEnabled()

Specified by:

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

setStatisticsEnabled

public CacheConfiguration<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).

Specified by:

setStatisticsEnabled in interface CacheConfiguration<K,V>

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>

getCacheLoaderFactory

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

Specified by:

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

setCacheLoaderFactory

public CacheConfiguration<K,V> setCacheLoaderFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheLoader<K,V>> cacheLoaderFactory)

Description copied from interface: CacheConfiguration

Set the CacheLoader factory.

Specified by:

setCacheLoaderFactory in interface CacheConfiguration<K,V>

Parameters:

cacheLoaderFactory - the CacheLoader Factory

Returns:

the CacheConfiguration to permit fluent-style method calls

setExpiryPolicyFactory

public CacheConfiguration<K,V> setExpiryPolicyFactory(javax.cache.configuration.Factory<? extends javax.cache.expiry.ExpiryPolicy> expiryPolicyFactory)

Description copied from interface: CacheConfiguration

Set the Factory for the ExpiryPolicy. If null is specified the default ExpiryPolicy is used.

Specified by:

setExpiryPolicyFactory in interface CacheConfiguration<K,V>

Parameters:

expiryPolicyFactory - the ExpiryPolicy Factory

Returns:

the CacheConfiguration to permit fluent-style method calls

setCacheWriterFactory

public CacheConfiguration<K,V> setCacheWriterFactory(javax.cache.configuration.Factory<? extends javax.cache.integration.CacheWriter<? super K,? super V>> cacheWriterFactory)

Description copied from interface: CacheConfiguration

Set the CacheWriter factory.

Specified by:

setCacheWriterFactory in interface CacheConfiguration<K,V>

Parameters:

cacheWriterFactory - the CacheWriter Factory

Returns:

the CacheConfiguration to permit fluent-style method calls

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>

isStoreByValue

public boolean isStoreByValue()

Specified by:

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

createConcurrentSet

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