NearCacheConfigReadOnly (Hazelcast Root 3.8 API)

java.lang.Object
- com.hazelcast.config.NearCacheConfig
- - com.hazelcast.config.NearCacheConfigReadOnly

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, Serializable

Deprecated.
this class will be removed in 4.0; it is meant for internal usage only.
```
public class NearCacheConfigReadOnly
extends NearCacheConfig
```
Contains configuration for a Near Cache (read-only).

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.hazelcast.config.NearCacheConfig
  NearCacheConfig.LocalUpdatePolicy

Field Summary
- Fields inherited from class com.hazelcast.config.NearCacheConfig
  DEFAULT_EVICTION_POLICY, DEFAULT_MAX_IDLE_SECONDS, DEFAULT_MAX_SIZE, DEFAULT_MEMORY_FORMAT, DEFAULT_TTL_SECONDS

Constructor Summary

Constructors
Constructor and Description

NearCacheConfigReadOnly()
Deprecated.

NearCacheConfigReadOnly(NearCacheConfig config)
Deprecated.

Constructors
Constructor and Description
`NearCacheConfigReadOnly()` Deprecated.
`NearCacheConfigReadOnly(NearCacheConfig config)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`EvictionConfig`	`getEvictionConfig()` Deprecated. The eviction configuration.
`int`	`getId()` Deprecated. Returns type identifier for this class.
`NearCachePreloaderConfig`	`getPreloaderConfig()` Deprecated.
`NearCacheConfig`	`setCacheLocalEntries(boolean cacheLocalEntries)` Deprecated. True to cache local entries also.
`NearCacheConfig`	`setEvictionConfig(EvictionConfig evictionConfig)` Deprecated. Sets the eviction configuration.
`NearCacheConfig`	`setEvictionPolicy(String evictionPolicy)` Deprecated. Sets the eviction policy.
`NearCacheConfig`	`setInMemoryFormat(InMemoryFormat inMemoryFormat)` Deprecated. Sets the data type used to store entries.
`NearCacheConfig`	`setInMemoryFormat(String inMemoryFormat)` Deprecated.
`NearCacheConfig`	`setInvalidateOnChange(boolean invalidateOnChange)` Deprecated. True to evict the cached entries if the entries are changed (updated or removed).
`NearCacheConfig`	`setLocalUpdatePolicy(NearCacheConfig.LocalUpdatePolicy localUpdatePolicy)` Deprecated.
`NearCacheConfig`	`setMaxIdleSeconds(int maxIdleSeconds)` Deprecated. Maximum number of seconds each entry can stay in the Near Cache as untouched (not-read).
`NearCacheConfig`	`setMaxSize(int maxSize)` Deprecated. Sets the maximum size of the Near Cache.
`NearCacheConfig`	`setName(String name)` Deprecated. Sets the name of the Near Cache.
`NearCacheConfig`	`setPreloaderConfig(NearCachePreloaderConfig preloaderConfig)` Deprecated.
`NearCacheConfig`	`setTimeToLiveSeconds(int timeToLiveSeconds)` Deprecated. Sets the maximum number of seconds for each entry to stay in the Near Cache.

Methods inherited from class com.hazelcast.config.NearCacheConfig
getAsReadOnly, getEvictionPolicy, getFactoryId, getInMemoryFormat, getLocalUpdatePolicy, getMaxIdleSeconds, getMaxSize, getName, getTimeToLiveSeconds, isCacheLocalEntries, isInvalidateOnChange, readData, toString, writeData

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

- Constructor Detail
  - NearCacheConfigReadOnly
```
public NearCacheConfigReadOnly()
```
    Deprecated.
  - NearCacheConfigReadOnly
```
public NearCacheConfigReadOnly(NearCacheConfig config)
```
    Deprecated.
- Method Detail
  - setName
```
public NearCacheConfig setName(String name)
```
    Deprecated.
    
    Description copied from class: NearCacheConfig
    
    Sets the name of the Near Cache.
    
    Overrides:
    
    setName in class NearCacheConfig
    
    Parameters:
    
    name - The name of the Near Cache.
    
    Returns:
    
    This Near Cache config instance.
  - setTimeToLiveSeconds
```
public NearCacheConfig setTimeToLiveSeconds(int timeToLiveSeconds)
```
    Deprecated.
    
    Description copied from class: NearCacheConfig
    
    Sets the maximum number of seconds for each entry to stay in the Near Cache. Entries that are older than time-to-live-seconds will get automatically evicted from the Near Cache. Any integer between 0 and Integer.MAX_VALUE. 0 means infinite. Default is 0.
    
    Overrides:
    
    setTimeToLiveSeconds in class NearCacheConfig
    
    Parameters:
    
    timeToLiveSeconds - The maximum number of seconds for each entry to stay in the Near Cache.
    
    Returns:
    
    This Near Cache config instance.
  - setMaxSize
```
public NearCacheConfig setMaxSize(int maxSize)
```
    Deprecated.
    
    Description copied from class: NearCacheConfig
    
    Sets the maximum size of the Near Cache. When max size is reached, cache is evicted based on the policy defined. Any integer between 0 and Integer.MAX_VALUE. 0 means Integer.MAX_VALUE. Default is 0.
    
    Overrides:
    
    setMaxSize in class NearCacheConfig
    
    Parameters:
    
    maxSize - The maximum number of seconds for each entry to stay in the Near Cache.
    
    Returns:
    
    This Near Cache config instance.
  - setEvictionPolicy
```
public NearCacheConfig setEvictionPolicy(String evictionPolicy)
```
    Deprecated.
    
    Description copied from class: NearCacheConfig
    
    Sets the eviction policy. Valid values are: LRU (Least Recently Used) LFU (Least Frequently Used) NONE (no extra eviction, time-to-live-seconds or max-idle-seconds may still apply) RANDOM (random entry) LRU is the default. Regardless of the eviction policy used, time-to-live-seconds and max-idle-seconds will still apply.
    
    Overrides:
    
    setEvictionPolicy in class NearCacheConfig
    
    Parameters:
    
    evictionPolicy - The eviction policy for the Near Cache.
    
    Returns:
    
    This Near Cache config instance.
  - setMaxIdleSeconds
```
public NearCacheConfig setMaxIdleSeconds(int maxIdleSeconds)
```
    Deprecated.
    
    Description copied from class: NearCacheConfig
    
    Maximum number of seconds each entry can stay in the Near Cache as untouched (not-read). Entries that are not read (touched) more than max-idle-seconds value will get removed from the Near Cache. Any integer between 0 and Integer.MAX_VALUE. 0 means Integer.MAX_VALUE. Default is 0.
    
    Overrides:
    
    setMaxIdleSeconds in class NearCacheConfig
    
    Parameters:
    
    maxIdleSeconds - Maximum number of seconds each entry can stay in the Near Cache as untouched (not-read).
    
    Returns:
    
    This Near Cache config instance.
  - setInvalidateOnChange
```
public NearCacheConfig setInvalidateOnChange(boolean invalidateOnChange)
```
    Deprecated.
    
    Description copied from class: NearCacheConfig
    
    True to evict the cached entries if the entries are changed (updated or removed). If set to true, the member will listen for cluster-wide changes on the entries and invalidate them on change. Changes done on the local member always invalidate the cache.
    
    Overrides:
    
    setInvalidateOnChange in class NearCacheConfig
    
    Parameters:
    
    invalidateOnChange - True to evict the cached entries if the entries are changed (updated or removed), false otherwise.
    
    Returns:
    
    This Near Cache config instance.
  - setInMemoryFormat
```
public NearCacheConfig setInMemoryFormat(InMemoryFormat inMemoryFormat)
```
    Deprecated.
    
    Description copied from class: NearCacheConfig
    
    Sets the data type used to store entries. Possible values: BINARY (default): keys and values are stored as binary data. OBJECT: values are stored in their object forms. NATIVE: keys and values are stored in native memory.
    
    Overrides:
    
    setInMemoryFormat in class NearCacheConfig
    
    Parameters:
    
    inMemoryFormat - The data type used to store entries.
    
    Returns:
    
    This Near Cache config instance.
  - setInMemoryFormat
```
public NearCacheConfig setInMemoryFormat(String inMemoryFormat)
```
    Deprecated.
    
    Overrides:
    
    setInMemoryFormat in class NearCacheConfig
  - setCacheLocalEntries
```
public NearCacheConfig setCacheLocalEntries(boolean cacheLocalEntries)
```
    Deprecated.
    
    Description copied from class: NearCacheConfig
    
    True to cache local entries also. This is useful when in-memory-format for Near Cache is different than the map's one.
    
    Overrides:
    
    setCacheLocalEntries in class NearCacheConfig
    
    Parameters:
    
    cacheLocalEntries - True to cache local entries also.
    
    Returns:
    
    This Near Cache config instance.
  - setLocalUpdatePolicy
```
public NearCacheConfig setLocalUpdatePolicy(NearCacheConfig.LocalUpdatePolicy localUpdatePolicy)
```
    Deprecated.
    
    Overrides:
    
    setLocalUpdatePolicy in class NearCacheConfig
  - setEvictionConfig
```
public NearCacheConfig setEvictionConfig(EvictionConfig evictionConfig)
```
    Deprecated.
    
    Description copied from class: NearCacheConfig
    
    Sets the eviction configuration.
    
    Overrides:
    
    setEvictionConfig in class NearCacheConfig
    
    Parameters:
    
    evictionConfig - The eviction configuration.
    
    Returns:
    
    This Near Cache config instance.
  - getEvictionConfig
```
public EvictionConfig getEvictionConfig()
```
    Deprecated.
    
    Description copied from class: NearCacheConfig
    
    The eviction configuration.
    
    Overrides:
    
    getEvictionConfig in class NearCacheConfig
    
    Returns:
    
    The eviction configuration.
  - setPreloaderConfig
```
public NearCacheConfig setPreloaderConfig(NearCachePreloaderConfig preloaderConfig)
```
    Deprecated.
    
    Overrides:
    
    setPreloaderConfig in class NearCacheConfig
  - getPreloaderConfig
```
public NearCachePreloaderConfig getPreloaderConfig()
```
    Deprecated.
    
    Overrides:
    
    getPreloaderConfig in class NearCacheConfig
  - getId
```
public int getId()
```
    Deprecated.
    
    Description copied from interface: IdentifiedDataSerializable
    
    Returns type identifier for this class. Id should be unique per DataSerializableFactory.
    
    Specified by:
    
    getId in interface IdentifiedDataSerializable
    
    Overrides:
    
    getId in class NearCacheConfig
    
    Returns:
    
    type id

Class NearCacheConfigReadOnly

Nested Class Summary

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

Field Summary

Fields inherited from class com.hazelcast.config.NearCacheConfig

Constructor Summary

Method Summary

Methods inherited from class com.hazelcast.config.NearCacheConfig

Methods inherited from class java.lang.Object

Constructor Detail

NearCacheConfigReadOnly

NearCacheConfigReadOnly

Method Detail

setName

setTimeToLiveSeconds

setMaxSize

setEvictionPolicy

setMaxIdleSeconds

setInvalidateOnChange

setInMemoryFormat

setInMemoryFormat

setCacheLocalEntries

setLocalUpdatePolicy

setEvictionConfig

getEvictionConfig

setPreloaderConfig

getPreloaderConfig

getId