com.hazelcast.internal.config

Class MapConfigReadOnly

java.lang.Object

com.hazelcast.config.MapConfig

com.hazelcast.internal.config.MapConfigReadOnly

All Implemented Interfaces:

NamedConfig, DataSerializable, IdentifiedDataSerializable, SplitBrainMergeTypeProvider

public class MapConfigReadOnly
extends MapConfig

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

Field Summary

Fields inherited from class com.hazelcast.config.MapConfig

DEFAULT_BACKUP_COUNT, DEFAULT_CACHED_DESERIALIZED_VALUES, DEFAULT_EVICTION_POLICY, DEFAULT_IN_MEMORY_FORMAT, DEFAULT_MAX_IDLE_SECONDS, DEFAULT_METADATA_POLICY, DEFAULT_TTL_SECONDS, MAX_BACKUP_COUNT, MIN_BACKUP_COUNT

Constructor Summary

Constructors

Constructor and Description
MapConfigReadOnly(MapConfig config)

Method Summary

Modifier and Type	Method and Description
MapConfig	addEntryListenerConfig(EntryListenerConfig listenerConfig)
MapConfig	addIndexConfig(IndexConfig indexConfig)
List<EntryListenerConfig>	getEntryListenerConfigs()
EventJournalConfig	getEventJournalConfig() Gets the EventJournalConfig for this MapConfig
HotRestartConfig	getHotRestartConfig() Gets the HotRestartConfig for this MapConfig
List<IndexConfig>	getIndexConfigs()
MapStoreConfig	getMapStoreConfig() Returns the map store configuration
MaxSizeConfig	getMaxSizeConfig()
MerkleTreeConfig	getMerkleTreeConfig() Gets the MerkleTreeConfig for this MapConfig
NearCacheConfig	getNearCacheConfig() Returns the Near Cache configuration
PartitioningStrategyConfig	getPartitioningStrategyConfig()
List<MapPartitionLostListenerConfig>	getPartitionLostListenerConfigs()
List<QueryCacheConfig>	getQueryCacheConfigs() Returns all QueryCacheConfig instances defined on this MapConfig.
WanReplicationRef	getWanReplicationRef() Gets the WAN target replication reference.
MapConfig	setAsyncBackupCount(int asyncBackupCount) Sets the number of asynchronous backups.
MapConfig	setAttributeConfigs(List<AttributeConfig> attributeConfigs)
MapConfig	setBackupCount(int backupCount) Number of synchronous backups.
MapConfig	setCacheDeserializedValues(CacheDeserializedValues cacheDeserializedValues) Configure de-serialized value caching.
MapConfig	setEntryListenerConfigs(List<EntryListenerConfig> listenerConfigs)
MapConfig	setEventJournalConfig(EventJournalConfig eventJournalConfig) Sets the EventJournalConfig for this MapConfig
MapConfig	setEvictionPolicy(EvictionPolicy evictionPolicy) Sets the EvictionPolicy.
MapConfig	setHotRestartConfig(HotRestartConfig hotRestartConfig) Sets the HotRestartConfig for this MapConfig
MapConfig	setIndexConfigs(List<IndexConfig> indexConfigs)
MapConfig	setInMemoryFormat(InMemoryFormat inMemoryFormat) Binary type that will be used for storing records.
MapConfig	setMapEvictionPolicy(MapEvictionPolicy mapEvictionPolicy) Sets custom eviction policy implementation for this map.
MapConfig	setMapStoreConfig(MapStoreConfig mapStoreConfig) Sets the map store configuration
MapConfig	setMaxIdleSeconds(int maxIdleSeconds) Maximum number of seconds for each entry to stay idle in the map.
MapConfig	setMaxSizeConfig(MaxSizeConfig maxSizeConfig)
MapConfig	setMergePolicyConfig(MergePolicyConfig mergePolicyConfig) Sets the MergePolicyConfig for this map.
MapConfig	setMerkleTreeConfig(MerkleTreeConfig merkleTreeConfig) Sets the MerkleTreeConfig for this MapConfig
MapConfig	setName(String name) Sets the name of the IMap
MapConfig	setNearCacheConfig(NearCacheConfig nearCacheConfig) Sets the Near Cache configuration
MapConfig	setPartitioningStrategyConfig(PartitioningStrategyConfig partitioningStrategyConfig)
MapConfig	setPartitionLostListenerConfigs(List<MapPartitionLostListenerConfig> listenerConfigs)
MapConfig	setQueryCacheConfigs(List<QueryCacheConfig> queryCacheConfigs) Sets QueryCacheConfig instances to this MapConfig.
MapConfig	setReadBackupData(boolean readBackupData) Sets read-backup-data (reading local backup entries) for this map.
MapConfig	setSplitBrainProtectionName(String splitBrainProtectionName)
MapConfig	setStatisticsEnabled(boolean statisticsEnabled) Sets statistics to enabled or disabled for this map.
MapConfig	setTimeToLiveSeconds(int timeToLiveSeconds) The maximum number of seconds for each entry to stay in the map.
MapConfig	setWanReplicationRef(WanReplicationRef wanReplicationRef) Sets the WAN target replication reference.

Methods inherited from class com.hazelcast.config.MapConfig

addAttributeConfig, addMapPartitionLostListenerConfig, addQueryCacheConfig, equals, getAsyncBackupCount, getAttributeConfigs, getBackupCount, getCacheDeserializedValues, getClassId, getEvictionPolicy, getFactoryId, getInMemoryFormat, getMapEvictionPolicy, getMaxIdleSeconds, getMergePolicyConfig, getMetadataPolicy, getName, getProvidedMergeTypes, getSplitBrainProtectionName, getTimeToLiveSeconds, getTotalBackupCount, hashCode, isNearCacheEnabled, isReadBackupData, isStatisticsEnabled, readData, setMetadataPolicy, toString, writeData

Methods inherited from class java.lang.Object

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

Constructor Detail

MapConfigReadOnly

public MapConfigReadOnly(MapConfig config)

Method Detail

getMaxSizeConfig

public MaxSizeConfig getMaxSizeConfig()

Overrides:

getMaxSizeConfig in class MapConfig

getWanReplicationRef

public WanReplicationRef getWanReplicationRef()

Description copied from class: MapConfig

Gets the WAN target replication reference.

Overrides:

getWanReplicationRef in class MapConfig

Returns:

the WAN target replication reference

getEntryListenerConfigs

public List<EntryListenerConfig> getEntryListenerConfigs()

Overrides:

getEntryListenerConfigs in class MapConfig

getPartitionLostListenerConfigs

public List<MapPartitionLostListenerConfig> getPartitionLostListenerConfigs()

Overrides:

getPartitionLostListenerConfigs in class MapConfig

getIndexConfigs

public List<IndexConfig> getIndexConfigs()

Overrides:

getIndexConfigs in class MapConfig

getPartitioningStrategyConfig

public PartitioningStrategyConfig getPartitioningStrategyConfig()

Overrides:

getPartitioningStrategyConfig in class MapConfig

getMapStoreConfig

public MapStoreConfig getMapStoreConfig()

Description copied from class: MapConfig

Returns the map store configuration

Overrides:

getMapStoreConfig in class MapConfig

Returns:

the mapStoreConfig (map store configuration)

getNearCacheConfig

public NearCacheConfig getNearCacheConfig()

Description copied from class: MapConfig

Returns the Near Cache configuration

Overrides:

getNearCacheConfig in class MapConfig

Returns:

the Near Cache configuration

getQueryCacheConfigs

public List<QueryCacheConfig> getQueryCacheConfigs()

Description copied from class: MapConfig

Returns all QueryCacheConfig instances defined on this MapConfig.

Overrides:

getQueryCacheConfigs in class MapConfig

Returns:

all QueryCacheConfig instances defined on this MapConfig

getMerkleTreeConfig

@Nonnull
public MerkleTreeConfig getMerkleTreeConfig()

Description copied from class: MapConfig

Gets the MerkleTreeConfig for this MapConfig

Overrides:

getMerkleTreeConfig in class MapConfig

Returns:

merkle tree config

setMerkleTreeConfig

public MapConfig setMerkleTreeConfig(@Nonnull
                                     MerkleTreeConfig merkleTreeConfig)

Description copied from class: MapConfig

Sets the MerkleTreeConfig for this MapConfig

Overrides:

setMerkleTreeConfig in class MapConfig

Parameters:

merkleTreeConfig - merkle tree config

Returns:

this MapConfig instance

getEventJournalConfig

@Nonnull
public EventJournalConfig getEventJournalConfig()

Description copied from class: MapConfig

Gets the EventJournalConfig for this MapConfig

Overrides:

getEventJournalConfig in class MapConfig

Returns:

event journal config

setEventJournalConfig

public MapConfig setEventJournalConfig(@Nonnull
                                       EventJournalConfig eventJournalConfig)

Description copied from class: MapConfig

Sets the EventJournalConfig for this MapConfig

Overrides:

setEventJournalConfig in class MapConfig

Parameters:

eventJournalConfig - event journal config

Returns:

this MapConfig instance

getHotRestartConfig

@Nonnull
public HotRestartConfig getHotRestartConfig()

Description copied from class: MapConfig

Gets the HotRestartConfig for this MapConfig

Overrides:

getHotRestartConfig in class MapConfig

Returns:

hot restart config

setHotRestartConfig

public MapConfig setHotRestartConfig(@Nonnull
                                     HotRestartConfig hotRestartConfig)

Description copied from class: MapConfig

Sets the HotRestartConfig for this MapConfig

Overrides:

setHotRestartConfig in class MapConfig

Parameters:

hotRestartConfig - hot restart config

Returns:

this MapConfig instance

setName

public MapConfig setName(String name)

Description copied from class: MapConfig

Sets the name of the IMap

Specified by:

setName in interface NamedConfig

Overrides:

setName in class MapConfig

Parameters:

name - the name to set for this IMap

setInMemoryFormat

public MapConfig setInMemoryFormat(InMemoryFormat inMemoryFormat)

Description copied from class: MapConfig

Binary 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
• NATIVE: values will be stored in non-heap region of JVM

Overrides:

setInMemoryFormat in class MapConfig

Parameters:

inMemoryFormat - the record type to set for this IMap

setBackupCount

public MapConfig setBackupCount(int backupCount)

Description copied from class: MapConfig

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 sync backup.

Overrides:

setBackupCount in class MapConfig

Parameters:

backupCount - the number of synchronous backups to set for this IMap

See Also:

MapConfig.setAsyncBackupCount(int)

setAsyncBackupCount

public MapConfig setAsyncBackupCount(int asyncBackupCount)

Description copied from class: MapConfig

Sets the number of asynchronous backups. 0 means no backups.

Overrides:

setAsyncBackupCount in class MapConfig

Parameters:

asyncBackupCount - the number of asynchronous synchronous backups to set

Returns:

the updated CacheConfig

See Also:

MapConfig.setBackupCount(int), MapConfig.getAsyncBackupCount()

setTimeToLiveSeconds

public MapConfig setTimeToLiveSeconds(int timeToLiveSeconds)

Description copied from class: MapConfig

The maximum number of seconds for each entry to stay in the map. Entries that are older than timeToLiveSeconds will be automatically evicted from the map. Updates on the entry will change the eviction time. Any integer between 0 and Integer.MAX_VALUE. 0 means infinite. Default is 0.

Overrides:

setTimeToLiveSeconds in class MapConfig

Parameters:

timeToLiveSeconds - the timeToLiveSeconds to set

setMaxIdleSeconds

public MapConfig setMaxIdleSeconds(int maxIdleSeconds)

Description copied from class: MapConfig

Maximum number of seconds for each entry to stay idle in the map. Entries that are idle (not touched) for more than maxIdleSeconds will get automatically evicted from the map. Entry is touched if get(), getAll(), put() or containsKey() is called. Any integer between 0 and Integer.MAX_VALUE. 0 means infinite. Default is 0. The time precision is limited by 1 second. The MaxIdle that less than 1 second can lead to unexpected behaviour.

Overrides:

setMaxIdleSeconds in class MapConfig

Parameters:

maxIdleSeconds - the maxIdleSeconds (the maximum number of seconds for each entry to stay idle in the map) to set

setMaxSizeConfig

public MapConfig setMaxSizeConfig(MaxSizeConfig maxSizeConfig)

Overrides:

setMaxSizeConfig in class MapConfig

setEvictionPolicy

public MapConfig setEvictionPolicy(EvictionPolicy evictionPolicy)

Description copied from class: MapConfig

Sets the EvictionPolicy. Default value is EvictionPolicy.NONE.

Overrides:

setEvictionPolicy in class MapConfig

Parameters:

evictionPolicy - the evictionPolicy to set

setMapEvictionPolicy

public MapConfig setMapEvictionPolicy(MapEvictionPolicy mapEvictionPolicy)

Description copied from class: MapConfig

Sets custom eviction policy implementation for this map.

Internal eviction algorithm finds most appropriate entry to evict from this map by using supplied policy.

Overrides:

setMapEvictionPolicy in class MapConfig

Parameters:

mapEvictionPolicy - custom eviction policy implementation

Returns:

the updated map configuration

setMapStoreConfig

public MapConfig setMapStoreConfig(MapStoreConfig mapStoreConfig)

Description copied from class: MapConfig

Sets the map store configuration

Overrides:

setMapStoreConfig in class MapConfig

Parameters:

mapStoreConfig - the mapStoreConfig (map store configuration) to set

setNearCacheConfig

public MapConfig setNearCacheConfig(NearCacheConfig nearCacheConfig)

Description copied from class: MapConfig

Sets the Near Cache configuration

Overrides:

setNearCacheConfig in class MapConfig

Parameters:

nearCacheConfig - the Near Cache configuration

Returns:

the updated map configuration

setMergePolicyConfig

public MapConfig setMergePolicyConfig(MergePolicyConfig mergePolicyConfig)

Description copied from class: MapConfig

Sets the MergePolicyConfig for this map.

Overrides:

setMergePolicyConfig in class MapConfig

Returns:

the updated map configuration

setStatisticsEnabled

public MapConfig setStatisticsEnabled(boolean statisticsEnabled)

Description copied from class: MapConfig

Sets statistics to enabled or disabled for this map.

Overrides:

setStatisticsEnabled in class MapConfig

Parameters:

statisticsEnabled - true to enable map statistics, false to disable

Returns:

the current map config instance

setReadBackupData

public MapConfig setReadBackupData(boolean readBackupData)

Description copied from class: MapConfig

Sets read-backup-data (reading local backup entries) for this map.

Overrides:

setReadBackupData in class MapConfig

Parameters:

readBackupData - true to enable read-backup-data, false to disable

Returns:

the current map config instance

setWanReplicationRef

public MapConfig setWanReplicationRef(WanReplicationRef wanReplicationRef)

Description copied from class: MapConfig

Sets the WAN target replication reference.

Overrides:

setWanReplicationRef in class MapConfig

Parameters:

wanReplicationRef - the WAN target replication reference

Returns:

the current map config instance

addEntryListenerConfig

public MapConfig addEntryListenerConfig(EntryListenerConfig listenerConfig)

Overrides:

addEntryListenerConfig in class MapConfig

setEntryListenerConfigs

public MapConfig setEntryListenerConfigs(List<EntryListenerConfig> listenerConfigs)

Overrides:

setEntryListenerConfigs in class MapConfig

setPartitioningStrategyConfig

public MapConfig setPartitioningStrategyConfig(PartitioningStrategyConfig partitioningStrategyConfig)

Overrides:

setPartitioningStrategyConfig in class MapConfig

setPartitionLostListenerConfigs

public MapConfig setPartitionLostListenerConfigs(List<MapPartitionLostListenerConfig> listenerConfigs)

Overrides:

setPartitionLostListenerConfigs in class MapConfig

setAttributeConfigs

public MapConfig setAttributeConfigs(List<AttributeConfig> attributeConfigs)

Overrides:

setAttributeConfigs in class MapConfig

setQueryCacheConfigs

public MapConfig setQueryCacheConfigs(List<QueryCacheConfig> queryCacheConfigs)

Description copied from class: MapConfig

Sets QueryCacheConfig instances to this MapConfig.

Overrides:

setQueryCacheConfigs in class MapConfig

Returns:

this configuration

setCacheDeserializedValues

public MapConfig setCacheDeserializedValues(CacheDeserializedValues cacheDeserializedValues)

Description copied from class: MapConfig

Configure de-serialized value caching. Default: CacheDeserializedValues.INDEX_ONLY

Overrides:

setCacheDeserializedValues in class MapConfig

Returns:

this MapConfig instance

See Also:

CacheDeserializedValues

setSplitBrainProtectionName

public MapConfig setSplitBrainProtectionName(String splitBrainProtectionName)

Overrides:

setSplitBrainProtectionName in class MapConfig

addIndexConfig

public MapConfig addIndexConfig(IndexConfig indexConfig)

Overrides:

addIndexConfig in class MapConfig

setIndexConfigs

public MapConfig setIndexConfigs(List<IndexConfig> indexConfigs)

Overrides:

setIndexConfigs in class MapConfig