MapConfig (Hazelcast Root 3.5 API)

java.lang.Object
- com.hazelcast.config.MapConfig

Direct Known Subclasses:

MapConfigReadOnly
```
public class MapConfig
extends Object
```
Contains the configuration for an IMap.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BACKUP_COUNT` The number of default backup counter
`static int`	`DEFAULT_EVICTION_PERCENTAGE` The number of default eviction percentage
`static EvictionPolicy`	`DEFAULT_EVICTION_POLICY` Default policy for eviction
`static InMemoryFormat`	`DEFAULT_IN_MEMORY_FORMAT` Default In-Memory format is binary
`static String`	`DEFAULT_MAP_MERGE_POLICY` Default policy for merging
`static int`	`DEFAULT_MAX_IDLE_SECONDS` The number of default time to wait eviction in seconds
`static long`	`DEFAULT_MIN_EVICTION_CHECK_MILLIS` Minimum time in milliseconds which should pass before asking if a partition of this map is evictable or not.
`static int`	`DEFAULT_TTL_SECONDS` The number of default Time to Live in seconds
`static int`	`MAX_BACKUP_COUNT` The number of maximum backup counter
`static int`	`MAX_EVICTION_PERCENTAGE` The number of maximum eviction percentage
`static int`	`MIN_BACKUP_COUNT` The number of minimum backup counter
`static int`	`MIN_EVICTION_PERCENTAGE` The number of minimum eviction percentage

Constructor Summary

Constructors
Constructor and Description

MapConfig()

MapConfig(MapConfig config)

MapConfig(String name)

Constructors
Constructor and Description
`MapConfig()`
`MapConfig(MapConfig config)`
`MapConfig(String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`MapConfig`	`addEntryListenerConfig(EntryListenerConfig listenerConfig)`
`MapConfig`	`addMapIndexConfig(MapIndexConfig mapIndexConfig)`
`MapConfig`	`addMapPartitionLostListenerConfig(MapPartitionLostListenerConfig listenerConfig)`
`MapConfig`	`addQueryCacheConfig(QueryCacheConfig queryCacheConfig)` Adds a new `queryCacheConfig` to this `MapConfig`.
`boolean`	`equals(Object obj)`
`MapConfigReadOnly`	`getAsReadOnly()`
`int`	`getAsyncBackupCount()` Returns the asynchronous backup count for this `IMap`.
`int`	`getBackupCount()` Returns the backupCount for this `IMap`
`List<EntryListenerConfig>`	`getEntryListenerConfigs()`
`int`	`getEvictionPercentage()` Returns the evictionPercentage: specified percentage of the map to be evicted
`EvictionPolicy`	`getEvictionPolicy()` Returns the evictionPolicy
`InMemoryFormat`	`getInMemoryFormat()` Returns the data type that will be used for storing records.
`List<MapIndexConfig>`	`getMapIndexConfigs()`
`MapStoreConfig`	`getMapStoreConfig()` Returns the map store configuration
`int`	`getMaxIdleSeconds()` Returns the maximum number of seconds for each entry to stay idle in the map.
`MaxSizeConfig`	`getMaxSizeConfig()`
`String`	`getMergePolicy()` Gets the map merge policy `MapMergePolicy`
`long`	`getMinEvictionCheckMillis()` Returns the minimum milliseconds which should pass before asking if a partition of this map is evictable or not.
`String`	`getName()` Returns the name of this `IMap`
`NearCacheConfig`	`getNearCacheConfig()` Returns the near cache configuration
`PartitioningStrategyConfig`	`getPartitioningStrategyConfig()`
`List<MapPartitionLostListenerConfig>`	`getPartitionLostListenerConfigs()`
`List<QueryCacheConfig>`	`getQueryCacheConfigs()` Returns all `QueryCacheConfig` instances defined on this `MapConfig`
`String`	`getQuorumName()`
`int`	`getTimeToLiveSeconds()` Returns the maximum number of seconds for each entry to stay in the map.
`int`	`getTotalBackupCount()` Returns the total number of backups: backupCount plus asyncBackupCount.
`WanReplicationRef`	`getWanReplicationRef()` Gets the Wan target replication reference.
`int`	`hashCode()`
`boolean`	`isCompatible(MapConfig other)`
`boolean`	`isNearCacheEnabled()` Checks if near cache is enabled
`boolean`	`isOptimizeQueries()`
`boolean`	`isReadBackupData()` Checks if read-backup-data (reading local backup entires) is enabled for this map.
`boolean`	`isStatisticsEnabled()` Checks if statistics are enabled for this map.
`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`	`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 minEvictionCheckMillis)` 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)`
`MapConfig`	`setPartitioningStrategyConfig(PartitioningStrategyConfig partitioningStrategyConfig)`
`MapConfig`	`setPartitionLostListenerConfigs(List<MapPartitionLostListenerConfig> listenerConfigs)`
`void`	`setQueryCacheConfigs(List<QueryCacheConfig> queryCacheConfigs)` Sets `QueryCacheConfig` instances to this `MapConfig`
`void`	`setQuorumName(String quorumName)`
`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.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MIN_BACKUP_COUNT
```
public static final int MIN_BACKUP_COUNT
```
    The number of minimum backup counter
    
    See Also:
    Constant Field Values
  - DEFAULT_BACKUP_COUNT
```
public static final int DEFAULT_BACKUP_COUNT
```
    The number of default backup counter
    
    See Also:
    Constant Field Values
  - MAX_BACKUP_COUNT
```
public static final int MAX_BACKUP_COUNT
```
    The number of maximum backup counter
    
    See Also:
    Constant Field Values
  - MIN_EVICTION_PERCENTAGE
```
public static final int MIN_EVICTION_PERCENTAGE
```
    The number of minimum eviction percentage
    
    See Also:
    Constant Field Values
  - DEFAULT_EVICTION_PERCENTAGE
```
public static final int DEFAULT_EVICTION_PERCENTAGE
```
    The number of default eviction percentage
    
    See Also:
    Constant Field Values
  - MAX_EVICTION_PERCENTAGE
```
public static final int MAX_EVICTION_PERCENTAGE
```
    The number of maximum eviction percentage
    
    See Also:
    Constant Field Values
  - DEFAULT_MIN_EVICTION_CHECK_MILLIS
```
public static final long DEFAULT_MIN_EVICTION_CHECK_MILLIS
```
    Minimum time in milliseconds which should pass before asking if a partition of this map is evictable or not.
    
    See Also:
    Constant Field Values
  - DEFAULT_TTL_SECONDS
```
public static final int DEFAULT_TTL_SECONDS
```
    The number of default Time to Live in seconds
    
    See Also:
    Constant Field Values
  - DEFAULT_MAX_IDLE_SECONDS
```
public static final int DEFAULT_MAX_IDLE_SECONDS
```
    The number of default time to wait eviction in seconds
    
    See Also:
    Constant Field Values
  - DEFAULT_EVICTION_POLICY
```
public static final EvictionPolicy DEFAULT_EVICTION_POLICY
```
    Default policy for eviction
  - DEFAULT_MAP_MERGE_POLICY
```
public static final String DEFAULT_MAP_MERGE_POLICY
```
    Default policy for merging
  - DEFAULT_IN_MEMORY_FORMAT
```
public static final InMemoryFormat DEFAULT_IN_MEMORY_FORMAT
```
    Default In-Memory format is binary
- Constructor Detail
  - MapConfig
```
public MapConfig(String name)
```
  - MapConfig
```
public MapConfig()
```
  - MapConfig
```
public MapConfig(MapConfig config)
```
- Method Detail
  - getAsReadOnly
```
public MapConfigReadOnly getAsReadOnly()
```
  - getName
```
public String getName()
```
    Returns the name of this IMap
    
    Returns:
    the name of the IMap
  - setName
```
public MapConfig setName(String name)
```
    Sets the name of the IMap
    
    Parameters:
    name - the name to set for this IMap
  - getInMemoryFormat
```
public InMemoryFormat getInMemoryFormat()
```
    Returns the data type that will be used for storing records.
    
    Returns:
    data type that will be used for storing records.
  - setInMemoryFormat
```
public MapConfig setInMemoryFormat(InMemoryFormat inMemoryFormat)
```
    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
    
    Parameters:
    inMemoryFormat - the record type to set for this IMap
    
    Throws:
    
    IllegalArgumentException - if inMemoryFormat is null.
  - getBackupCount
```
public int getBackupCount()
```
    Returns the backupCount for this IMap
    
    Returns:
    the backupCount for this IMap
    See Also:
    getAsyncBackupCount()
  - setBackupCount
```
public MapConfig setBackupCount(int backupCount)
```
    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.
    
    Parameters:
    backupCount - the number of synchronous backups to set for this IMap
    See Also:
    setAsyncBackupCount(int)
  - getAsyncBackupCount
```
public int getAsyncBackupCount()
```
    Returns the asynchronous backup count for this IMap.
    
    Returns:
    the asynchronous backup count
    See Also:
    setBackupCount(int)
  - setAsyncBackupCount
```
public MapConfig setAsyncBackupCount(int asyncBackupCount)
```
    Sets the number of asynchronous backups. 0 means no backups.
    
    Parameters:
    asyncBackupCount - the number of asynchronous synchronous backups to set
    
    Returns:
    the updated CacheConfig
    
    Throws:
    
    new - IllegalArgumentException if asyncBackupCount smaller than 0, or larger than the maximum number of backup or the sum of the backups and async backups is larger than the maximum number of backups
    See Also:
    setBackupCount(int), getAsyncBackupCount()
  - getTotalBackupCount
```
public int getTotalBackupCount()
```
    Returns the total number of backups: backupCount plus asyncBackupCount.
    
    Returns:
    the total number of backups: synchronous + asynchronous
  - getEvictionPercentage
```
public int getEvictionPercentage()
```
    Returns the evictionPercentage: specified percentage of the map to be evicted
    
    Returns:
    the evictionPercentage: specified percentage of the map to be evicted
  - setEvictionPercentage
```
public MapConfig setEvictionPercentage(int evictionPercentage)
```
    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.
    
    Parameters:
    evictionPercentage - the evictionPercentage to set: the specified percentage of the map to be evicted
    
    Throws:
    
    IllegalArgumentException - if evictionPercentage is not in the 0-100 range.
  - getMinEvictionCheckMillis
```
public long getMinEvictionCheckMillis()
```
    Returns the minimum milliseconds which should pass before asking if a partition of this map is evictable or not.
    Default value is 100L milliseconds.
    
    Returns:
    number of milliseconds that should pass before asking for the next eviction.
    Since:
    
    3.3
  - setMinEvictionCheckMillis
```
public MapConfig setMinEvictionCheckMillis(long minEvictionCheckMillis)
```
    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.
    
    Parameters:
    minEvictionCheckMillis - time in milliseconds that should pass before asking for the next eviction
    Since:
    
    3.3
  - getTimeToLiveSeconds
```
public int getTimeToLiveSeconds()
```
    Returns the maximum number of seconds for each entry to stay in the map.
    
    Returns:
    the maximum number of seconds for each entry to stay in the map
  - setTimeToLiveSeconds
```
public MapConfig setTimeToLiveSeconds(int timeToLiveSeconds)
```
    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.
    
    Parameters:
    timeToLiveSeconds - the timeToLiveSeconds to set
  - getMaxIdleSeconds
```
public int getMaxIdleSeconds()
```
    Returns the maximum number of seconds for each entry to stay idle in the map.
    
    Returns:
    the maximum number of seconds for each entry to stay idle in the map
  - setMaxIdleSeconds
```
public MapConfig setMaxIdleSeconds(int maxIdleSeconds)
```
    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.
    
    Parameters:
    maxIdleSeconds - the maxIdleSeconds (the maximum number of seconds for each entry to stay idle in the map) to set
  - getMaxSizeConfig
```
public MaxSizeConfig getMaxSizeConfig()
```
  - setMaxSizeConfig
```
public MapConfig setMaxSizeConfig(MaxSizeConfig maxSizeConfig)
```
  - getEvictionPolicy
```
public EvictionPolicy getEvictionPolicy()
```
    Returns the evictionPolicy
    
    Returns:
    the evictionPolicy
  - setEvictionPolicy
```
public MapConfig setEvictionPolicy(EvictionPolicy evictionPolicy)
```
    Sets the evictionPolicy
    
    Parameters:
    evictionPolicy - the evictionPolicy to set
  - getMapStoreConfig
```
public MapStoreConfig getMapStoreConfig()
```
    Returns the map store configuration
    
    Returns:
    the mapStoreConfig (map store configuration)
  - setMapStoreConfig
```
public MapConfig setMapStoreConfig(MapStoreConfig mapStoreConfig)
```
    Sets the map store configuration
    
    Parameters:
    mapStoreConfig - the mapStoreConfig (map store configuration) to set
  - getNearCacheConfig
```
public NearCacheConfig getNearCacheConfig()
```
    Returns the near cache configuration
    
    Returns:
    the near cache configuration
  - setNearCacheConfig
```
public MapConfig setNearCacheConfig(NearCacheConfig nearCacheConfig)
```
    Sets the near cache configuration
    
    Parameters:
    nearCacheConfig - the near cache configuration
    
    Returns:
    the updated map configuration
  - getMergePolicy
```
public String getMergePolicy()
```
    Gets the map merge policy MapMergePolicy
    
    Returns:
    the updated map configuration
  - setMergePolicy
```
public MapConfig setMergePolicy(String mergePolicy)
```
    Sets the map merge policy MapMergePolicy
    
    Parameters:
    mergePolicy - the map merge policy to set
    
    Returns:
    the updated map configuration
  - isStatisticsEnabled
```
public boolean isStatisticsEnabled()
```
    Checks if statistics are enabled for this map.
    
    Returns:
    True if statistics are enabled, false otherwise.
  - setStatisticsEnabled
```
public MapConfig setStatisticsEnabled(boolean statisticsEnabled)
```
    Sets statistics to enabled or disabled for this map.
    
    Parameters:
    statisticsEnabled - True to enable map statistics, false to disable.
    
    Returns:
    The current map config instance.
  - isReadBackupData
```
public boolean isReadBackupData()
```
    Checks if read-backup-data (reading local backup entires) is enabled for this map.
    
    Returns:
    True if read-backup-data is enabled, false otherwise.
  - setReadBackupData
```
public MapConfig setReadBackupData(boolean readBackupData)
```
    Sets read-backup-data (reading local backup entires) for this map.
    
    Parameters:
    readBackupData - True to enable read-backup-data, false to disable.
    
    Returns:
    The current map config instance.
  - getWanReplicationRef
```
public WanReplicationRef getWanReplicationRef()
```
    Gets the Wan target replication reference.
    
    Returns:
    The Wan target replication reference.
  - setWanReplicationRef
```
public MapConfig setWanReplicationRef(WanReplicationRef wanReplicationRef)
```
    Sets the Wan target replication reference.
    
    Parameters:
    wanReplicationRef - the Wan target replication reference.
    
    Returns:
    The current map config instance.
  - addEntryListenerConfig
```
public MapConfig addEntryListenerConfig(EntryListenerConfig listenerConfig)
```
  - getEntryListenerConfigs
```
public List<EntryListenerConfig> getEntryListenerConfigs()
```
  - setEntryListenerConfigs
```
public MapConfig setEntryListenerConfigs(List<EntryListenerConfig> listenerConfigs)
```
  - addMapPartitionLostListenerConfig
```
public MapConfig addMapPartitionLostListenerConfig(MapPartitionLostListenerConfig listenerConfig)
```
  - getPartitionLostListenerConfigs
```
public List<MapPartitionLostListenerConfig> getPartitionLostListenerConfigs()
```
  - setPartitionLostListenerConfigs
```
public MapConfig setPartitionLostListenerConfigs(List<MapPartitionLostListenerConfig> listenerConfigs)
```
  - addMapIndexConfig
```
public MapConfig addMapIndexConfig(MapIndexConfig mapIndexConfig)
```
  - getMapIndexConfigs
```
public List<MapIndexConfig> getMapIndexConfigs()
```
  - setMapIndexConfigs
```
public MapConfig setMapIndexConfigs(List<MapIndexConfig> mapIndexConfigs)
```
  - addQueryCacheConfig
```
public MapConfig addQueryCacheConfig(QueryCacheConfig queryCacheConfig)
```
    Adds a new queryCacheConfig to this MapConfig.
    
    Parameters:
    queryCacheConfig - the config to be added.
    
    Returns:
    this MapConfig instance.
    
    Throws:
    
    IllegalArgumentException - if there is already a QueryCache with the same QueryCacheConfig#name.
  - getQueryCacheConfigs
```
public List<QueryCacheConfig> getQueryCacheConfigs()
```
    Returns all QueryCacheConfig instances defined on this MapConfig
    
    Returns:
    all QueryCacheConfig instances defined on this MapConfig
  - setQueryCacheConfigs
```
public void setQueryCacheConfigs(List<QueryCacheConfig> queryCacheConfigs)
```
    Sets QueryCacheConfig instances to this MapConfig
  - getPartitioningStrategyConfig
```
public PartitioningStrategyConfig getPartitioningStrategyConfig()
```
  - setPartitioningStrategyConfig
```
public MapConfig setPartitioningStrategyConfig(PartitioningStrategyConfig partitioningStrategyConfig)
```
  - isNearCacheEnabled
```
public boolean isNearCacheEnabled()
```
    Checks if near cache is enabled
    
    Returns:
    true if near cache is enabled, false otherwise
  - isOptimizeQueries
```
public boolean isOptimizeQueries()
```
  - setOptimizeQueries
```
public MapConfig setOptimizeQueries(boolean optimizeQueries)
```
  - isCompatible
```
public boolean isCompatible(MapConfig other)
```
  - getQuorumName
```
public String getQuorumName()
```
  - setQuorumName
```
public void setQuorumName(String quorumName)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MapConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_BACKUP_COUNT

DEFAULT_BACKUP_COUNT

MAX_BACKUP_COUNT

MIN_EVICTION_PERCENTAGE

DEFAULT_EVICTION_PERCENTAGE

MAX_EVICTION_PERCENTAGE

DEFAULT_MIN_EVICTION_CHECK_MILLIS

DEFAULT_TTL_SECONDS

DEFAULT_MAX_IDLE_SECONDS

DEFAULT_EVICTION_POLICY

DEFAULT_MAP_MERGE_POLICY

DEFAULT_IN_MEMORY_FORMAT

Constructor Detail

MapConfig

MapConfig

MapConfig

Method Detail

getAsReadOnly

getName

setName

getInMemoryFormat

setInMemoryFormat

getBackupCount

setBackupCount

getAsyncBackupCount

setAsyncBackupCount

getTotalBackupCount

getEvictionPercentage

setEvictionPercentage

getMinEvictionCheckMillis

setMinEvictionCheckMillis

getTimeToLiveSeconds

setTimeToLiveSeconds

getMaxIdleSeconds

setMaxIdleSeconds

getMaxSizeConfig

setMaxSizeConfig

getEvictionPolicy

setEvictionPolicy

getMapStoreConfig

setMapStoreConfig

getNearCacheConfig

setNearCacheConfig

getMergePolicy

setMergePolicy

isStatisticsEnabled

setStatisticsEnabled

isReadBackupData

setReadBackupData

getWanReplicationRef

setWanReplicationRef

addEntryListenerConfig

getEntryListenerConfigs

setEntryListenerConfigs

addMapPartitionLostListenerConfig

getPartitionLostListenerConfigs

setPartitionLostListenerConfigs

addMapIndexConfig

getMapIndexConfigs

setMapIndexConfigs

addQueryCacheConfig

getQueryCacheConfigs

setQueryCacheConfigs

getPartitioningStrategyConfig

setPartitioningStrategyConfig

isNearCacheEnabled

isOptimizeQueries

setOptimizeQueries

isCompatible

getQuorumName

setQuorumName

hashCode

equals

toString