com.hazelcast.config

Class MapConfigReadOnly

java.lang.Object

com.hazelcast.config.MapConfig

com.hazelcast.config.MapConfigReadOnly

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_PERCENTAGE, DEFAULT_EVICTION_POLICY, DEFAULT_IN_MEMORY_FORMAT, DEFAULT_MAP_MERGE_POLICY, DEFAULT_MAX_IDLE_SECONDS, DEFAULT_MIN_EVICTION_CHECK_MILLIS, DEFAULT_TTL_SECONDS, MAX_BACKUP_COUNT, MAX_EVICTION_PERCENTAGE, MIN_BACKUP_COUNT, MIN_EVICTION_PERCENTAGE

Method Summary

Methods

Modifier and Type	Method and Description
MapConfig	addEntryListenerConfig(EntryListenerConfig listenerConfig)
MapConfig	addMapIndexConfig(MapIndexConfig mapIndexConfig)
List<EntryListenerConfig>	getEntryListenerConfigs()
List<MapIndexConfig>	getMapIndexConfigs()
MapStoreConfig	getMapStoreConfig() Returns the map store configuration
MaxSizeConfig	getMaxSizeConfig()
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	setBackupCount(int backupCount) Number of synchronous backups.
MapConfig	setEntryListenerConfigs(List<EntryListenerConfig> listenerConfigs)
MapConfig	setEvictionPercentage(int evictionPercentage) When maximum size is reached, the specified percentage of the map will be evicted.
MapConfig	setEvictionPolicy(EvictionPolicy evictionPolicy) Sets the evictionPolicy
MapConfig	setHotRestartConfig(HotRestartConfig hotRestartConfig) Sets the HotRestartConfig for this MapConfig
MapConfig	setInMemoryFormat(InMemoryFormat inMemoryFormat) Binary type that will be used for storing records.
MapConfig	setMapIndexConfigs(List<MapIndexConfig> mapIndexConfigs)
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	setMergePolicy(String mergePolicy) Sets the map merge policy MapMergePolicy
MapConfig	setMinEvictionCheckMillis(long checkIfEvictableAfterMillis) Sets the minimum time in milliseconds which should pass before asking if a partition of this map is evictable or not.
MapConfig	setName(String name) Sets the name of the IMap
MapConfig	setNearCacheConfig(NearCacheConfig nearCacheConfig) Sets the near cache configuration
MapConfig	setOptimizeQueries(boolean optimizeQueries) Enable de-serialized value caching when evaluating predicates.
MapConfig	setPartitioningStrategyConfig(PartitioningStrategyConfig partitioningStrategyConfig)
MapConfig	setReadBackupData(boolean readBackupData) Sets read-backup-data (reading local backup entires) for this map.
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

addMapAttributeConfig, addMapPartitionLostListenerConfig, addQueryCacheConfig, equals, getAsReadOnly, getAsyncBackupCount, getBackupCount, getCacheDeserializedValues, getEvictionPercentage, getEvictionPolicy, getHotRestartConfig, getInMemoryFormat, getMapAttributeConfigs, getMaxIdleSeconds, getMergePolicy, getMinEvictionCheckMillis, getName, getQuorumName, getTimeToLiveSeconds, getTotalBackupCount, hashCode, isCompatible, isNearCacheEnabled, isOptimizeQueries, isReadBackupData, isStatisticsEnabled, setCacheDeserializedValues, setMapAttributeConfigs, setPartitionLostListenerConfigs, setQueryCacheConfigs, setQuorumName, toString

Methods inherited from class java.lang.Object

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

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

getMapIndexConfigs

public List<MapIndexConfig> getMapIndexConfigs()

Overrides:

getMapIndexConfigs 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

setHotRestartConfig

public MapConfig setHotRestartConfig(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

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

setEvictionPercentage

public MapConfig setEvictionPercentage(int evictionPercentage)

Description copied from class: MapConfig

When maximum size is reached, the specified percentage of the map will be evicted. Any integer between 0 and 100 is allowed. For example, if 25 is set, 25% of the entries will be evicted.

Beware that eviction mechanism is different for NATIVE in-memory format (It uses a probabilistic algorithm based on sampling. Please see documentation for further details) and this parameter has no effect.

Overrides:

setEvictionPercentage in class MapConfig

Parameters:

evictionPercentage - the evictionPercentage to set: the specified percentage of the map to be evicted

setMinEvictionCheckMillis

public MapConfig setMinEvictionCheckMillis(long checkIfEvictableAfterMillis)

Description copied from class: MapConfig

Sets the minimum time in milliseconds which should pass before asking if a partition of this map is evictable or not.

Default value is 100L milliseconds.

Beware that eviction mechanism is different for NATIVE in-memory format (It uses a probabilistic algorithm based on sampling. Please see documentation for further details) and this parameter has no effect.

Overrides:

setMinEvictionCheckMillis in class MapConfig

Parameters:

checkIfEvictableAfterMillis - time in milliseconds that should pass before asking for the next eviction

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 do not 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.

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

Overrides:

setEvictionPolicy in class MapConfig

Parameters:

evictionPolicy - the evictionPolicy to set

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

setMergePolicy

public MapConfig setMergePolicy(String mergePolicy)

Description copied from class: MapConfig

Sets the map merge policy MapMergePolicy

Overrides:

setMergePolicy in class MapConfig

Parameters:

mergePolicy - the map merge policy to set

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

addMapIndexConfig

public MapConfig addMapIndexConfig(MapIndexConfig mapIndexConfig)

Overrides:

addMapIndexConfig in class MapConfig

setMapIndexConfigs

public MapConfig setMapIndexConfigs(List<MapIndexConfig> mapIndexConfigs)

Overrides:

setMapIndexConfigs in class MapConfig

setPartitioningStrategyConfig

public MapConfig setPartitioningStrategyConfig(PartitioningStrategyConfig partitioningStrategyConfig)

Overrides:

setPartitioningStrategyConfig in class MapConfig

setOptimizeQueries

public MapConfig setOptimizeQueries(boolean optimizeQueries)

Description copied from class: MapConfig

Enable de-serialized value caching when evaluating predicates. It has no effect when InMemoryFormat is InMemoryFormat.OBJECT or when Portable serialization is used.

Overrides:

setOptimizeQueries in class MapConfig

Returns:

this MapConfig instance.

See Also:

CacheDeserializedValues}