NearCacheConfig (Hazelcast Root 3.8 API)

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

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, Serializable

Direct Known Subclasses:

NearCacheConfigReadOnly
```
public class NearCacheConfig
extends Object
implements IdentifiedDataSerializable, Serializable
```
Contains the configuration for a Near Cache.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NearCacheConfig.LocalUpdatePolicy
Used to decide how to reflect local updates to near cache.

Nested Classes
Modifier and Type	Class and Description
`static class`	`NearCacheConfig.LocalUpdatePolicy` Used to decide how to reflect local updates to near cache.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_EVICTION_POLICY` Deprecated. since 3.8, please use `EvictionConfig.DEFAULT_EVICTION_POLICY`
`static int`	`DEFAULT_MAX_IDLE_SECONDS` Default value of the idle time for eviction in seconds.
`static int`	`DEFAULT_MAX_SIZE` Deprecated. since 3.8, please use `EvictionConfig.DEFAULT_MAX_ENTRY_COUNT_FOR_ON_HEAP_MAP`
`static InMemoryFormat`	`DEFAULT_MEMORY_FORMAT` Default value for the in-memory format.
`static int`	`DEFAULT_TTL_SECONDS` Default value of the time to live in seconds.

Constructor Summary

Constructors
Constructor and Description
`NearCacheConfig()`
`NearCacheConfig(int timeToLiveSeconds, int maxIdleSeconds, boolean invalidateOnChange, InMemoryFormat inMemoryFormat)`
`NearCacheConfig(int timeToLiveSeconds, int maxIdleSeconds, boolean invalidateOnChange, InMemoryFormat inMemoryFormat, EvictionConfig evictionConfig)`
`NearCacheConfig(int timeToLiveSeconds, int maxSize, String evictionPolicy, int maxIdleSeconds, boolean invalidateOnChange, InMemoryFormat inMemoryFormat)` Deprecated. since 3.8, please use `NearCacheConfig(int, int, boolean, InMemoryFormat)`
`NearCacheConfig(int timeToLiveSeconds, int maxSize, String evictionPolicy, int maxIdleSeconds, boolean invalidateOnChange, InMemoryFormat inMemoryFormat, EvictionConfig evictionConfig)` Deprecated. since 3.8, please use `NearCacheConfig(int, int, boolean, InMemoryFormat, EvictionConfig)`
`NearCacheConfig(NearCacheConfig config)`
`NearCacheConfig(String name)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`NearCacheConfigReadOnly`	`getAsReadOnly()` Deprecated. this method will be removed in 4.0; it is meant for internal usage only.
`EvictionConfig`	`getEvictionConfig()` The eviction configuration.
`String`	`getEvictionPolicy()` Deprecated. since 3.8, use `getEvictionConfig()` and `EvictionConfig.getEvictionPolicy()` instead
`int`	`getFactoryId()` Returns DataSerializableFactory factory id for this class.
`int`	`getId()` Returns type identifier for this class.
`InMemoryFormat`	`getInMemoryFormat()` Gets the data type used to store entries.
`NearCacheConfig.LocalUpdatePolicy`	`getLocalUpdatePolicy()`
`int`	`getMaxIdleSeconds()` Maximum number of seconds each entry can stay in the Near Cache as untouched (not-read).
`int`	`getMaxSize()` Deprecated. since 3.8, use `getEvictionConfig()` and `EvictionConfig.getSize()` instead
`String`	`getName()` Gets the name of the Near Cache.
`NearCachePreloaderConfig`	`getPreloaderConfig()`
`int`	`getTimeToLiveSeconds()` Gets the maximum number of seconds for each entry to stay in the Near Cache.
`boolean`	`isCacheLocalEntries()` If true, cache local entries also.
`boolean`	`isInvalidateOnChange()` True to evict the cached entries if the entries are changed (updated or removed).
`void`	`readData(ObjectDataInput in)` Reads fields from the input stream
`NearCacheConfig`	`setCacheLocalEntries(boolean cacheLocalEntries)` True to cache local entries also.
`NearCacheConfig`	`setEvictionConfig(EvictionConfig evictionConfig)` Sets the eviction configuration.
`NearCacheConfig`	`setEvictionPolicy(String evictionPolicy)` Deprecated. since 3.8, use `setEvictionConfig(EvictionConfig)` and `EvictionConfig.setEvictionPolicy(EvictionPolicy)` instead
`NearCacheConfig`	`setInMemoryFormat(InMemoryFormat inMemoryFormat)` Sets the data type used to store entries.
`NearCacheConfig`	`setInMemoryFormat(String inMemoryFormat)`
`NearCacheConfig`	`setInvalidateOnChange(boolean invalidateOnChange)` True to evict the cached entries if the entries are changed (updated or removed).
`NearCacheConfig`	`setLocalUpdatePolicy(NearCacheConfig.LocalUpdatePolicy localUpdatePolicy)`
`NearCacheConfig`	`setMaxIdleSeconds(int maxIdleSeconds)` Maximum number of seconds each entry can stay in the Near Cache as untouched (not-read).
`NearCacheConfig`	`setMaxSize(int maxSize)` Deprecated. since 3.8, use `setEvictionConfig(EvictionConfig)` and `EvictionConfig.setSize(int)` instead
`NearCacheConfig`	`setName(String name)` Sets the name of the Near Cache.
`NearCacheConfig`	`setPreloaderConfig(NearCachePreloaderConfig preloaderConfig)`
`NearCacheConfig`	`setTimeToLiveSeconds(int timeToLiveSeconds)` Sets the maximum number of seconds for each entry to stay in the Near Cache.
`String`	`toString()`
`void`	`writeData(ObjectDataOutput out)` Writes object fields to output stream

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

- Field Detail
  - DEFAULT_TTL_SECONDS
```
public static final int DEFAULT_TTL_SECONDS
```
    Default value of the time to live in seconds.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_IDLE_SECONDS
```
public static final int DEFAULT_MAX_IDLE_SECONDS
```
    Default value of the idle time for eviction in seconds.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MEMORY_FORMAT
```
public static final InMemoryFormat DEFAULT_MEMORY_FORMAT
```
    Default value for the in-memory format.
  - DEFAULT_MAX_SIZE
```
public static final int DEFAULT_MAX_SIZE
```
    Deprecated. since 3.8, please use EvictionConfig.DEFAULT_MAX_ENTRY_COUNT_FOR_ON_HEAP_MAP
    
    Default value of the maximum size.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EVICTION_POLICY
```
public static final String DEFAULT_EVICTION_POLICY
```
    Deprecated. since 3.8, please use EvictionConfig.DEFAULT_EVICTION_POLICY
    
    Default value for the eviction policy.
- Constructor Detail
  - NearCacheConfig
```
public NearCacheConfig()
```
  - NearCacheConfig
```
public NearCacheConfig(String name)
```
  - NearCacheConfig
```
public NearCacheConfig(int timeToLiveSeconds,
                       int maxIdleSeconds,
                       boolean invalidateOnChange,
                       InMemoryFormat inMemoryFormat)
```
  - NearCacheConfig
```
public NearCacheConfig(int timeToLiveSeconds,
                       int maxIdleSeconds,
                       boolean invalidateOnChange,
                       InMemoryFormat inMemoryFormat,
                       EvictionConfig evictionConfig)
```
  - NearCacheConfig
```
public NearCacheConfig(int timeToLiveSeconds,
                       int maxSize,
                       String evictionPolicy,
                       int maxIdleSeconds,
                       boolean invalidateOnChange,
                       InMemoryFormat inMemoryFormat)
```
    Deprecated. since 3.8, please use NearCacheConfig(int, int, boolean, InMemoryFormat)
  - NearCacheConfig
```
public NearCacheConfig(int timeToLiveSeconds,
                       int maxSize,
                       String evictionPolicy,
                       int maxIdleSeconds,
                       boolean invalidateOnChange,
                       InMemoryFormat inMemoryFormat,
                       EvictionConfig evictionConfig)
```
    Deprecated. since 3.8, please use NearCacheConfig(int, int, boolean, InMemoryFormat, EvictionConfig)
  - NearCacheConfig
```
public NearCacheConfig(NearCacheConfig config)
```
- Method Detail
  - getAsReadOnly
```
public NearCacheConfigReadOnly getAsReadOnly()
```
    Deprecated. this method will be removed in 4.0; it is meant for internal usage only.
    
    Gets immutable version of this configuration.
    
    Returns:
    
    Immutable version of this configuration.
  - getName
```
public String getName()
```
    Gets the name of the Near Cache.
    
    Returns:
    
    The name of the Near Cache.
  - setName
```
public NearCacheConfig setName(String name)
```
    Sets the name of the Near Cache.
    
    Parameters:
    
    name - The name of the Near Cache.
    
    Returns:
    
    This Near Cache config instance.
  - getTimeToLiveSeconds
```
public int getTimeToLiveSeconds()
```
    Gets 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.
    
    Returns:
    
    The maximum number of seconds for each entry to stay in the Near Cache.
  - setTimeToLiveSeconds
```
public NearCacheConfig setTimeToLiveSeconds(int timeToLiveSeconds)
```
    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.
    
    Parameters:
    
    timeToLiveSeconds - The maximum number of seconds for each entry to stay in the Near Cache.
    
    Returns:
    
    This Near Cache config instance.
  - getMaxSize
```
public int getMaxSize()
```
    Deprecated. since 3.8, use getEvictionConfig() and EvictionConfig.getSize() instead
    
    Gets the maximum size of the Near Cache. When max size is reached, cache is evicted based on the policy defined.
    
    Returns:
    
    The maximum size of the Near Cache.
  - setMaxSize
```
public NearCacheConfig setMaxSize(int maxSize)
```
    Deprecated. since 3.8, use setEvictionConfig(EvictionConfig) and EvictionConfig.setSize(int) instead
    
    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.
    
    Parameters:
    
    maxSize - The maximum number of seconds for each entry to stay in the Near Cache.
    
    Returns:
    
    This Near Cache config instance.
  - getEvictionPolicy
```
public String getEvictionPolicy()
```
    Deprecated. since 3.8, use getEvictionConfig() and EvictionConfig.getEvictionPolicy() instead
    
    Returns the eviction policy for the Near Cache.
    
    Returns:
    
    The eviction policy for the Near Cache.
  - setEvictionPolicy
```
public NearCacheConfig setEvictionPolicy(String evictionPolicy)
```
    Deprecated. since 3.8, use setEvictionConfig(EvictionConfig) and EvictionConfig.setEvictionPolicy(EvictionPolicy) instead
    
    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.
    
    Parameters:
    
    evictionPolicy - The eviction policy for the Near Cache.
    
    Returns:
    
    This Near Cache config instance.
  - getMaxIdleSeconds
```
public int getMaxIdleSeconds()
```
    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.
    
    Returns:
    
    Maximum number of seconds each entry can stay in the Near Cache as untouched (not-read).
  - setMaxIdleSeconds
```
public NearCacheConfig setMaxIdleSeconds(int maxIdleSeconds)
```
    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.
    
    Parameters:
    
    maxIdleSeconds - Maximum number of seconds each entry can stay in the Near Cache as untouched (not-read).
    
    Returns:
    
    This Near Cache config instance.
  - isInvalidateOnChange
```
public boolean isInvalidateOnChange()
```
    True to evict the cached entries if the entries are changed (updated or removed). When true, the member listens for cluster-wide changes on the entries and invalidates them on change. Changes done on the local member always invalidate the cache.
    
    Returns:
    
    This Near Cache config instance.
  - setInvalidateOnChange
```
public NearCacheConfig setInvalidateOnChange(boolean invalidateOnChange)
```
    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.
    
    Parameters:
    
    invalidateOnChange - True to evict the cached entries if the entries are changed (updated or removed), false otherwise.
    
    Returns:
    
    This Near Cache config instance.
  - getInMemoryFormat
```
public InMemoryFormat getInMemoryFormat()
```
    Gets 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.
    
    Returns:
    
    The data type used to store entries.
  - setInMemoryFormat
```
public NearCacheConfig setInMemoryFormat(InMemoryFormat inMemoryFormat)
```
    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.
    
    Parameters:
    
    inMemoryFormat - The data type used to store entries.
    
    Returns:
    
    This Near Cache config instance.
  - isCacheLocalEntries
```
public boolean isCacheLocalEntries()
```
    If true, cache local entries also. This is useful when in-memory-format for Near Cache is different than the map's one.
    
    Returns:
    
    True if local entries are cached also.
  - setCacheLocalEntries
```
public NearCacheConfig setCacheLocalEntries(boolean cacheLocalEntries)
```
    True to cache local entries also. This is useful when in-memory-format for Near Cache is different than the map's one.
    
    Parameters:
    
    cacheLocalEntries - True to cache local entries also.
    
    Returns:
    
    This Near Cache config instance.
  - getLocalUpdatePolicy
```
public NearCacheConfig.LocalUpdatePolicy getLocalUpdatePolicy()
```
  - setLocalUpdatePolicy
```
public NearCacheConfig setLocalUpdatePolicy(NearCacheConfig.LocalUpdatePolicy localUpdatePolicy)
```
  - setInMemoryFormat
```
public NearCacheConfig setInMemoryFormat(String inMemoryFormat)
```
  - getEvictionConfig
```
public EvictionConfig getEvictionConfig()
```
    The eviction configuration.
    
    Returns:
    
    The eviction configuration.
  - setEvictionConfig
```
public NearCacheConfig setEvictionConfig(EvictionConfig evictionConfig)
```
    Sets the eviction configuration.
    
    Parameters:
    
    evictionConfig - The eviction configuration.
    
    Returns:
    
    This Near Cache config instance.
  - getPreloaderConfig
```
public NearCachePreloaderConfig getPreloaderConfig()
```
  - setPreloaderConfig
```
public NearCacheConfig setPreloaderConfig(NearCachePreloaderConfig preloaderConfig)
```
  - getFactoryId
```
public int getFactoryId()
```
    Description copied from interface: IdentifiedDataSerializable
    
    Returns DataSerializableFactory factory id for this class.
    
    Specified by:
    
    getFactoryId in interface IdentifiedDataSerializable
    
    Returns:
    
    factory id
  - getId
```
public int getId()
```
    Description copied from interface: IdentifiedDataSerializable
    
    Returns type identifier for this class. Id should be unique per DataSerializableFactory.
    
    Specified by:
    
    getId in interface IdentifiedDataSerializable
    
    Returns:
    
    type id
  - writeData
```
public void writeData(ObjectDataOutput out)
               throws IOException
```
    Description copied from interface: DataSerializable
    
    Writes object fields to output stream
    
    Specified by:
    
    writeData in interface DataSerializable
    
    Parameters:
    
    out - output
    
    Throws:
    
    IOException
  - readData
```
public void readData(ObjectDataInput in)
              throws IOException
```
    Description copied from interface: DataSerializable
    
    Reads fields from the input stream
    
    Specified by:
    
    readData in interface DataSerializable
    
    Parameters:
    
    in - input
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class NearCacheConfig

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TTL_SECONDS

DEFAULT_MAX_IDLE_SECONDS

DEFAULT_MEMORY_FORMAT

DEFAULT_MAX_SIZE

DEFAULT_EVICTION_POLICY

Constructor Detail

NearCacheConfig

NearCacheConfig

NearCacheConfig

NearCacheConfig

NearCacheConfig

NearCacheConfig

NearCacheConfig

Method Detail

getAsReadOnly

getName

setName

getTimeToLiveSeconds

setTimeToLiveSeconds

getMaxSize

setMaxSize

getEvictionPolicy

setEvictionPolicy

getMaxIdleSeconds

setMaxIdleSeconds

isInvalidateOnChange

setInvalidateOnChange

getInMemoryFormat

setInMemoryFormat

isCacheLocalEntries

setCacheLocalEntries

getLocalUpdatePolicy

setLocalUpdatePolicy

setInMemoryFormat

getEvictionConfig

setEvictionConfig

getPreloaderConfig

setPreloaderConfig

getFactoryId

getId

writeData

readData

toString