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 - type of the key

V - type of the value

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>

Readonly version of CacheConfig

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	hotRestartEnabled Whether Hot Restart is enabled
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 EvictionConfig instance of the eviction configuration for this ICache.
javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy>	getExpiryPolicyFactory()
Class<K>	getKeyType()
String	getQuorumName() Gets the name of the associated quorum if any.
Class<V>	getValueType()
WanReplicationRef	getWanReplicationRef()
boolean	isHotRestartEnabled() Returns whether hot restart enabled on this cache.
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 for this ICache.
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(EvictionConfig evictionConfig) Sets the EvictionConfig instance for eviction configuration for this ICache.
CacheConfiguration<K,V>	setExpiryPolicyFactory(javax.cache.configuration.Factory<? extends javax.cache.expiry.ExpiryPolicy> expiryPolicyFactory) Set the Factory for the ExpiryPolicy.
CacheConfiguration<K,V>	setHotRestartEnabled(boolean hotRestart) Sets whether hot restart is enabled on this cache.
CacheConfig<K,V>	setInMemoryFormat(InMemoryFormat inMemoryFormat) Data type that will be used to store records in this ICache.
CacheConfig<K,V>	setManagementEnabled(boolean enabled) Sets whether or not management is enabled on this cache.
CacheConfig<K,V>	setManagerPrefix(String managerPrefix) Sets the manager prefix of the ICache.
void	setMergePolicy(String mergePolicy) Sets the class name of CacheMergePolicy implementation to this cache config.
CacheConfig<K,V>	setName(String name) Sets the name of this ICache.
CacheConfig	setPartitionLostListenerConfigs(List<CachePartitionLostListenerConfig> partitionLostListenerConfigs) Sets the WAN target replication reference.
CacheConfig	setQuorumName(String quorumName) Associates this cache configuration to a quorum.
CacheConfiguration<K,V>	setReadThrough(boolean isReadThrough) Set if read-through caching should be used.
CacheConfiguration<K,V>	setStatisticsEnabled(boolean enabled) Sets whether or not statistics gathering is enabled on this 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 the global identifier of the ICache.
CacheConfig	setWanReplicationRef(WanReplicationRef wanReplicationRef)
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, getMergePolicy, getName, getNameWithPrefix, getPartitionLostListenerConfigs, 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

hotRestartEnabled

protected boolean hotRestartEnabled

Whether Hot Restart is enabled

Method Detail

getEvictionConfig

public CacheEvictionConfig getEvictionConfig()

Description copied from class: CacheConfig

Gets the EvictionConfig instance of the eviction configuration for this ICache.

Overrides:

getEvictionConfig in class CacheConfig<K,V>

Returns:

The EvictionConfig instance of the eviction configuration.

getWanReplicationRef

public WanReplicationRef getWanReplicationRef()

Overrides:

getWanReplicationRef in class CacheConfig<K,V>

getQuorumName

public String getQuorumName()

Description copied from class: CacheConfig

Gets the name of the associated quorum if any.

Overrides:

getQuorumName in class CacheConfig<K,V>

Returns:

the name of the associated quorum if any

getCacheEntryListenerConfigurations

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

Specified by:

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

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

setName

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

Description copied from class: CacheConfig

Sets the name of this ICache.

Overrides:

setName in class CacheConfig<K,V>

Parameters:

name - The name to set for this ICache.

Returns:

The current cache config instance.

setManagerPrefix

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

Description copied from class: CacheConfig

Sets the manager prefix of the ICache.

Overrides:

setManagerPrefix in class CacheConfig<K,V>

Parameters:

managerPrefix - The manager prefix to set for this ICache.

Returns:

The current cache config instance.

setUriString

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

Description copied from class: CacheConfig

Sets the URI string, which is the global identifier of the ICache.

Overrides:

setUriString in class CacheConfig<K,V>

Parameters:

uriString - The URI string to set for this ICache.

Returns:

The current cache config instance.

setBackupCount

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

Description copied from class: CacheConfig

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

Overrides:

setBackupCount in class CacheConfig<K,V>

Parameters:

backupCount - The number of synchronous backups to set for this ICache.

Returns:

The 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 for this ICache.

Overrides:

setAsyncBackupCount in class CacheConfig<K,V>

Parameters:

asyncBackupCount - The number of asynchronous backups to set for this ICache.

Returns:

the updated CacheConfig

See Also:

CacheConfig.setBackupCount(int), CacheConfig.getAsyncBackupCount()

setEvictionConfig

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

Description copied from class: CacheConfig

Sets the EvictionConfig instance for eviction configuration for this ICache.

Overrides:

setEvictionConfig in class CacheConfig<K,V>

Parameters:

evictionConfig - The EvictionConfig instance to set for the eviction configuration.

Returns:

The current cache config instance.

setInMemoryFormat

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

Description copied from class: CacheConfig

Data type that will be used to store records in this ICache. 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 or not management is enabled on this 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

setStatisticsEnabled

public CacheConfiguration<K,V> setStatisticsEnabled(boolean enabled)

Sets whether or not statistics gathering is enabled on this 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

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

setWanReplicationRef

public CacheConfig setWanReplicationRef(WanReplicationRef wanReplicationRef)

Overrides:

setWanReplicationRef in class CacheConfig<K,V>

setQuorumName

public CacheConfig setQuorumName(String quorumName)

Description copied from class: CacheConfig

Associates this cache configuration to a quorum.

Overrides:

setQuorumName in class CacheConfig<K,V>

Parameters:

quorumName - name of the desired quorum.

Returns:

the updated CacheConfig.

setHotRestartEnabled

public CacheConfiguration<K,V> setHotRestartEnabled(boolean hotRestart)

Sets whether hot restart is enabled on this cache.

Returns:

this

setPartitionLostListenerConfigs

public CacheConfig setPartitionLostListenerConfigs(List<CachePartitionLostListenerConfig> partitionLostListenerConfigs)

Description copied from class: CacheConfig

Sets the WAN target replication reference.

Overrides:

setPartitionLostListenerConfigs in class CacheConfig<K,V>

Parameters:

partitionLostListenerConfigs - CachePartitionLostListenerConfig list.

setMergePolicy

public void setMergePolicy(String mergePolicy)

Description copied from class: CacheConfig

Sets the class name of CacheMergePolicy implementation to this cache config.

Overrides:

setMergePolicy in class CacheConfig<K,V>

Parameters:

mergePolicy - the class name of CacheMergePolicy implementation to be set to this cache config

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

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

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

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, false otherwise

Returns:

the CacheConfiguration to permit fluent-style method calls

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, false otherwise

Returns:

the CacheConfiguration to permit fluent-style method calls

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>

isManagementEnabled

public boolean isManagementEnabled()

Specified by:

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

isHotRestartEnabled

public boolean isHotRestartEnabled()

Returns whether hot restart enabled on this cache.

Returns:

true if hot restart enabled, false otherwise

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>

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()