MapConfigReadOnly (Hazelcast Root 3.3 API)

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

public class MapConfigReadOnly
extends MapConfig

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

Nested Class Summary
- Nested classes/interfaces inherited from class com.hazelcast.config.MapConfig
  MapConfig.EvictionPolicy

Field Summary
- Fields inherited from class com.hazelcast.config.MapConfig
  DEFAULT_BACKUP_COUNT, DEFAULT_EVICTION_PERCENTAGE, DEFAULT_EVICTION_POLICY, DEFAULT_IN_MEMORY_FORMAT, DEFAULT_MAP_MERGE_POLICY, DEFAULT_MAX_IDLE_SECONDS, DEFAULT_MAX_SIZE, 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()`
`PartitioningStrategyConfig`	`getPartitioningStrategyConfig()`
`WanReplicationRef`	`getWanReplicationRef()`
`MapConfig`	`setAsyncBackupCount(int asyncBackupCount)` Number of asynchronous backups.
`MapConfig`	`setBackupCount(int backupCount)` Number of synchronous backups.
`MapConfig`	`setEntryListenerConfigs(List<EntryListenerConfig> listenerConfigs)`
`MapConfig`	`setEvictionPercentage(int evictionPercentage)` When max.
`MapConfig`	`setEvictionPolicy(MapConfig.EvictionPolicy evictionPolicy)`
`MapConfig`	`setInMemoryFormat(InMemoryFormat inMemoryFormat)` Data type that will be used for storing records.
`MapConfig`	`setMapIndexConfigs(List<MapIndexConfig> mapIndexConfigs)`
`MapConfig`	`setMapStoreConfig(MapStoreConfig mapStoreConfig)` Sets the mapStore 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)`
`MapConfig`	`setMinEvictionCheckMillis(long checkIfEvictableAfterMillis)` Sets the minimum time in millis which should pass before asking if a partition of this map is evictable or not.
`MapConfig`	`setName(String name)`
`MapConfig`	`setNearCacheConfig(NearCacheConfig nearCacheConfig)`
`MapConfig`	`setOptimizeQueries(boolean optimizeQueries)`
`MapConfig`	`setPartitioningStrategyConfig(PartitioningStrategyConfig partitioningStrategyConfig)`
`MapConfig`	`setReadBackupData(boolean readBackupData)`
`MapConfig`	`setStatisticsEnabled(boolean statisticsEnabled)`
`MapConfig`	`setTimeToLiveSeconds(int timeToLiveSeconds)` Maximum number of seconds for each entry to stay in the map.
`MapConfig`	`setWanReplicationRef(WanReplicationRef wanReplicationRef)`

Methods inherited from class com.hazelcast.config.MapConfig
equals, getAsReadOnly, getAsyncBackupCount, getBackupCount, getEvictionPercentage, getEvictionPolicy, getInMemoryFormat, getMaxIdleSeconds, getMergePolicy, getMinEvictionCheckMillis, getName, getTimeToLiveSeconds, getTotalBackupCount, hashCode, isCompatible, isNearCacheEnabled, isOptimizeQueries, isReadBackupData, isStatisticsEnabled, 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()
```
    Overrides:
    
    getWanReplicationRef in class MapConfig
  - getEntryListenerConfigs
```
public List<EntryListenerConfig> getEntryListenerConfigs()
```
    Overrides:
    
    getEntryListenerConfigs 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
  - getNearCacheConfig
```
public NearCacheConfig getNearCacheConfig()
```
    Overrides:
    
    getNearCacheConfig in class MapConfig
  - setName
```
public MapConfig setName(String name)
```
    Overrides:
    
    setName in class MapConfig
    
    Parameters:
    name - the name to set
  - setInMemoryFormat
```
public MapConfig setInMemoryFormat(InMemoryFormat inMemoryFormat)
```
    Description copied from class: MapConfig
    
    Data 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 OFFHEAP : values will be stored in non-heap region of JVM
    
    Overrides:
    
    setInMemoryFormat in class MapConfig
    
    Parameters:
    inMemoryFormat - the record type to set
  - setBackupCount
```
public MapConfig setBackupCount(int backupCount)
```
    Description copied from class: MapConfig
    
    Number of synchronous backups. If 1 is set as the backup-count for example, 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 backupCount to set
    See Also:
    MapConfig.setAsyncBackupCount(int)
  - setAsyncBackupCount
```
public MapConfig setAsyncBackupCount(int asyncBackupCount)
```
    Description copied from class: MapConfig
    
    Number of asynchronous backups. 0 means no backup.
    
    Overrides:
    
    setAsyncBackupCount in class MapConfig
    
    Parameters:
    asyncBackupCount - the asyncBackupCount to set
    See Also:
    MapConfig.setBackupCount(int)
  - setEvictionPercentage
```
public MapConfig setEvictionPercentage(int evictionPercentage)
```
    Description copied from class: MapConfig
    
    When max. size is reached, specified percentage of the map will be evicted. Any integer between 0 and 100 is allowed. If 25 is set for example, 25% of the entries will get evicted.
    
    Overrides:
    
    setEvictionPercentage in class MapConfig
    
    Parameters:
    evictionPercentage - the evictionPercentage to set
  - setMinEvictionCheckMillis
```
public MapConfig setMinEvictionCheckMillis(long checkIfEvictableAfterMillis)
```
    Description copied from class: MapConfig
    
    Sets the minimum time in millis which should pass before asking if a partition of this map is evictable or not.
    Default value is 100L milliseconds.
    
    Overrides:
    
    setMinEvictionCheckMillis in class MapConfig
    
    Parameters:
    checkIfEvictableAfterMillis - time in millis.
  - setTimeToLiveSeconds
```
public MapConfig setTimeToLiveSeconds(int timeToLiveSeconds)
```
    Description copied from class: MapConfig
    
    Maximum number of seconds for each entry to stay in the map. Entries that are older than timeToLiveSeconds will get automatically evicted from the map. Updates on the entry don't 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 to set
  - setMaxSizeConfig
```
public MapConfig setMaxSizeConfig(MaxSizeConfig maxSizeConfig)
```
    Overrides:
    
    setMaxSizeConfig in class MapConfig
  - setEvictionPolicy
```
public MapConfig setEvictionPolicy(MapConfig.EvictionPolicy 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 mapStore configuration
    
    Overrides:
    
    setMapStoreConfig in class MapConfig
    
    Parameters:
    mapStoreConfig - the mapStoreConfig to set
  - setNearCacheConfig
```
public MapConfig setNearCacheConfig(NearCacheConfig nearCacheConfig)
```
    Overrides:
    
    setNearCacheConfig in class MapConfig
  - setMergePolicy
```
public MapConfig setMergePolicy(String mergePolicy)
```
    Overrides:
    
    setMergePolicy in class MapConfig
  - setStatisticsEnabled
```
public MapConfig setStatisticsEnabled(boolean statisticsEnabled)
```
    Overrides:
    
    setStatisticsEnabled in class MapConfig
  - setReadBackupData
```
public MapConfig setReadBackupData(boolean readBackupData)
```
    Overrides:
    
    setReadBackupData in class MapConfig
  - setWanReplicationRef
```
public MapConfig setWanReplicationRef(WanReplicationRef wanReplicationRef)
```
    Overrides:
    
    setWanReplicationRef in class MapConfig
  - 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)
```
    Overrides:
    
    setOptimizeQueries in class MapConfig

Class MapConfigReadOnly

Nested Class Summary

Nested classes/interfaces inherited from class com.hazelcast.config.MapConfig

Field Summary

Fields inherited from class com.hazelcast.config.MapConfig

Method Summary

Methods inherited from class com.hazelcast.config.MapConfig

Methods inherited from class java.lang.Object

Method Detail

getMaxSizeConfig

getWanReplicationRef

getEntryListenerConfigs

getMapIndexConfigs

getPartitioningStrategyConfig

getMapStoreConfig

getNearCacheConfig

setName

setInMemoryFormat

setBackupCount

setAsyncBackupCount

setEvictionPercentage

setMinEvictionCheckMillis

setTimeToLiveSeconds

setMaxIdleSeconds

setMaxSizeConfig

setEvictionPolicy

setMapStoreConfig

setNearCacheConfig

setMergePolicy

setStatisticsEnabled

setReadBackupData

setWanReplicationRef

addEntryListenerConfig

setEntryListenerConfigs

addMapIndexConfig

setMapIndexConfigs

setPartitioningStrategyConfig

setOptimizeQueries