com.hazelcast.config

Class NearCacheConfigReadOnly

java.lang.Object

com.hazelcast.config.NearCacheConfig

com.hazelcast.config.NearCacheConfigReadOnly

All Implemented Interfaces:

DataSerializable, Serializable

public class NearCacheConfigReadOnly
extends NearCacheConfig

Contains configuration for an NearCache(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(NearCacheConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
NearCacheConfig	setCacheLocalEntries(boolean cacheLocalEntries) True to cache local entries also.
NearCacheConfig	setEvictionPolicy(String evictionPolicy) Valid values are: NONE (no extra eviction, time-to-live-seconds may still apply), LRU (Least Recently Used), LFU (Least Frequently Used).
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	setMaxIdleSeconds(int maxIdleSeconds) Maximum number of seconds each entry can stay in the near cache as untouched (not-read).
NearCacheConfig	setMaxSize(int maxSize) Sets the maximum size of the near cache.
NearCacheConfig	setName(String name) Sets the name of the near cache.
NearCacheConfig	setTimeToLiveSeconds(int timeToLiveSeconds) Sets the maximum number of seconds for each entry to stay in the near cache.

Methods inherited from class com.hazelcast.config.NearCacheConfig

getAsReadOnly, getEvictionConfig, getEvictionPolicy, getInMemoryFormat, getLocalUpdatePolicy, getMaxIdleSeconds, getMaxSize, getName, getTimeToLiveSeconds, isCacheLocalEntries, isInvalidateOnChange, readData, setEvictionConfig, setLocalUpdatePolicy, toString, writeData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NearCacheConfigReadOnly

public NearCacheConfigReadOnly(NearCacheConfig config)

Method Detail

setName

public NearCacheConfig setName(String name)

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)

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)

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)

Description copied from class: NearCacheConfig

Valid values are: NONE (no extra eviction, time-to-live-seconds may still apply), LRU (Least Recently Used), LFU (Least Frequently Used). NONE is the default. Regardless of the eviction policy used, time-to-live-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)

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)

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)

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)

Overrides:

setInMemoryFormat in class NearCacheConfig

setCacheLocalEntries

public NearCacheConfig setCacheLocalEntries(boolean cacheLocalEntries)

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.