com.hazelcast.internal.config

Class CacheConfigReadOnly<K,V>

java.lang.Object

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

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

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

Type Parameters:

K - type of the key

V - type of the value

All Implemented Interfaces:

CacheConfiguration<K,V>, DataSerializable, SplitBrainMergeTypeProvider, 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 inherited from class com.hazelcast.config.AbstractCacheConfig

cacheLoaderFactory, cacheWriterFactory, classLoader, eventJournalConfig, expiryPolicyFactory, hotRestartConfig, isManagementEnabled, isReadThrough, isStatisticsEnabled, isStoreByValue, isWriteThrough, listenerConfigurations, serializationService

Constructor Summary

Constructors

Constructor and Description
CacheConfigReadOnly(CacheConfig config)

Method Summary

Modifier and Type	Method and Description
CacheConfig<K,V>	addCacheEntryListenerConfiguration(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> cacheEntryListenerConfiguration) Add a configuration for a CacheEntryListener.
Iterable<javax.cache.configuration.CacheEntryListenerConfiguration<K,V>>	getCacheEntryListenerConfigurations()
EventJournalConfig	getEventJournalConfig() Gets the EventJournalConfig for this CacheConfiguration
EvictionConfig	getEvictionConfig() Gets the EvictionConfig instance of the eviction configuration for this ICache.
HotRestartConfig	getHotRestartConfig() Gets the HotRestartConfig for this CacheConfiguration
String	getSplitBrainProtectionName() Gets the name of the associated split brain protection if any.
WanReplicationRef	getWanReplicationRef()
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>	setDisablePerEntryInvalidationEvents(boolean disablePerEntryInvalidationEvents) Sets invalidation events disabled status for per entry.
CacheConfiguration<K,V>	setEventJournalConfig(EventJournalConfig eventJournalConfig) Sets the EventJournalConfig for this CacheConfiguration
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>	setHotRestartConfig(HotRestartConfig hotRestartConfig) Sets the HotRestartConfig for this CacheConfiguration
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.
CacheConfig<K,V>	setMergePolicyConfig(MergePolicyConfig mergePolicyConfig) Sets the MergePolicyConfig for this map.
CacheConfig<K,V>	setName(String name) Sets the name of this ICache.
CacheConfig<K,V>	setPartitionLostListenerConfigs(List<CachePartitionLostListenerConfig> partitionLostListenerConfigs) Sets the WAN target replication reference.
CacheConfiguration<K,V>	setReadThrough(boolean isReadThrough) Set if read-through caching should be used.
CacheConfig<K,V>	setSplitBrainProtectionName(String splitBrainProtectionName) Associates this cache configuration to a split brain protection.
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<K,V>	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

copy, equals, getAsyncBackupCount, getBackupCount, getInMemoryFormat, getManagerPrefix, getMergePolicyConfig, getName, getNameWithPrefix, getPartitionLostListenerConfigs, getProvidedMergeTypes, getTotalBackupCount, getUriString, hashCode, isDisablePerEntryInvalidationEvents, readData, readFactories, readKeyValueTypes, readListenerConfigurations, readTenant, toString, writeData, writeFactories, writeKeyValueTypes, writeListenerConfigurations, writeTenant

Methods inherited from class com.hazelcast.config.AbstractCacheConfig

createConcurrentSet, getCacheLoaderFactory, getCacheWriterFactory, getExpiryPolicyFactory, getKeyClassName, getKeyType, getListenerConfigurations, getValueClassName, getValueType, hasListenerConfiguration, isManagementEnabled, isReadThrough, isStatisticsEnabled, isStoreByValue, isWriteThrough, keyValueTypesEqual, setClassLoader, setKeyClassName, setKeyType, setListenerConfigurations, setListenerConfigurations, setValueClassName, setValueType

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheConfigReadOnly

public CacheConfigReadOnly(CacheConfig config)

Method Detail

getEvictionConfig

public EvictionConfig 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>

getHotRestartConfig

@Nonnull
public HotRestartConfig getHotRestartConfig()

Description copied from class: AbstractCacheConfig

Gets the HotRestartConfig for this CacheConfiguration

Overrides:

getHotRestartConfig in class AbstractCacheConfig<K,V>

Returns:

hot restart config

getEventJournalConfig

@Nonnull
public EventJournalConfig getEventJournalConfig()

Description copied from class: AbstractCacheConfig

Gets the EventJournalConfig for this CacheConfiguration

Overrides:

getEventJournalConfig in class AbstractCacheConfig<K,V>

Returns:

event journal config

getSplitBrainProtectionName

public String getSplitBrainProtectionName()

Description copied from class: CacheConfig

Gets the name of the associated split brain protection if any.

Overrides:

getSplitBrainProtectionName in class CacheConfig<K,V>

Returns:

the name of the associated split brain protection if any

getCacheEntryListenerConfigurations

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

Specified by:

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

Overrides:

getCacheEntryListenerConfigurations in class AbstractCacheConfig<K,V>

addCacheEntryListenerConfiguration

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

Description copied from class: AbstractCacheConfig

Add a configuration for a CacheEntryListener.

Specified by:

addCacheEntryListenerConfiguration in interface CacheConfiguration<K,V>

Overrides:

addCacheEntryListenerConfiguration in class AbstractCacheConfig<K,V>

Parameters:

cacheEntryListenerConfiguration - the CacheEntryListenerConfiguration

Returns:

the CacheConfig

removeCacheEntryListenerConfiguration

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

Description copied from class: AbstractCacheConfig

Remove a configuration for a CacheEntryListener.

Specified by:

removeCacheEntryListenerConfiguration in interface CacheConfiguration<K,V>

Overrides:

removeCacheEntryListenerConfiguration in class AbstractCacheConfig<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)

Description copied from class: AbstractCacheConfig

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>

Overrides:

setManagementEnabled in class AbstractCacheConfig<K,V>

Parameters:

enabled - true to enable statistics, false to disable

Returns:

the CacheConfig

setStatisticsEnabled

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

Description copied from class: AbstractCacheConfig

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>

Overrides:

setStatisticsEnabled in class AbstractCacheConfig<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)

Description copied from class: AbstractCacheConfig

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>

Overrides:

setTypes in class AbstractCacheConfig<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)

Description copied from class: AbstractCacheConfig

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

Specified by:

setStoreByValue in interface CacheConfiguration<K,V>

Overrides:

setStoreByValue in class AbstractCacheConfig<K,V>

Parameters:

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

Returns:

the CacheConfig

setWanReplicationRef

public CacheConfig<K,V> setWanReplicationRef(WanReplicationRef wanReplicationRef)

Overrides:

setWanReplicationRef in class CacheConfig<K,V>

setSplitBrainProtectionName

public CacheConfig<K,V> setSplitBrainProtectionName(String splitBrainProtectionName)

Description copied from class: CacheConfig

Associates this cache configuration to a split brain protection.

Overrides:

setSplitBrainProtectionName in class CacheConfig<K,V>

Parameters:

splitBrainProtectionName - name of the desired split brain protection

Returns:

the updated CacheConfig

setHotRestartConfig

public CacheConfiguration<K,V> setHotRestartConfig(@Nonnull
                                                   HotRestartConfig hotRestartConfig)

Description copied from class: AbstractCacheConfig

Sets the HotRestartConfig for this CacheConfiguration

Overrides:

setHotRestartConfig in class AbstractCacheConfig<K,V>

Parameters:

hotRestartConfig - hot restart config

Returns:

this CacheConfiguration instance

setPartitionLostListenerConfigs

public CacheConfig<K,V> 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

setMergePolicyConfig

public CacheConfig<K,V> setMergePolicyConfig(MergePolicyConfig mergePolicyConfig)

Description copied from class: CacheConfig

Sets the MergePolicyConfig for this map.

Overrides:

setMergePolicyConfig in class CacheConfig<K,V>

Returns:

the updated map configuration

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>

Overrides:

setExpiryPolicyFactory in class AbstractCacheConfig<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>

Overrides:

setCacheLoaderFactory in class AbstractCacheConfig<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>

Overrides:

setCacheWriterFactory in class AbstractCacheConfig<K,V>

Parameters:

cacheWriterFactory - the CacheWriter Factory

Returns:

the CacheConfiguration to permit fluent-style method calls

setEventJournalConfig

public CacheConfiguration<K,V> setEventJournalConfig(@Nonnull
                                                     EventJournalConfig eventJournalConfig)

Description copied from class: AbstractCacheConfig

Sets the EventJournalConfig for this CacheConfiguration

Overrides:

setEventJournalConfig in class AbstractCacheConfig<K,V>

Parameters:

eventJournalConfig - event journal config

Returns:

this CacheConfiguration instance

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>

Overrides:

setWriteThrough in class AbstractCacheConfig<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>

Overrides:

setReadThrough in class AbstractCacheConfig<K,V>

Parameters:

isReadThrough - true if read-through is required, false otherwise

Returns:

the CacheConfiguration to permit fluent-style method calls

setDisablePerEntryInvalidationEvents

public CacheConfig<K,V> setDisablePerEntryInvalidationEvents(boolean disablePerEntryInvalidationEvents)

Description copied from class: CacheConfig

Sets invalidation events disabled status for per entry.

Overrides:

setDisablePerEntryInvalidationEvents in class CacheConfig<K,V>

Parameters:

disablePerEntryInvalidationEvents - disables invalidation event sending behaviour if it is true, otherwise enables it

Returns:

this configuration