com.hazelcast.config

Class NearCacheConfig

java.lang.Object

com.hazelcast.config.NearCacheConfig

All Implemented Interfaces:

DataSerializable, Serializable

Direct Known Subclasses:

NearCacheConfigReadOnly

public class NearCacheConfig
extends Object
implements DataSerializable, Serializable

Contains configuration for an NearCache.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NearCacheConfig.LocalUpdatePolicy Local Update Policy enum.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_EVICTION_POLICY Default eviction policy
static int	DEFAULT_MAX_IDLE_SECONDS Default value of idle in seconds for eviction.
static int	DEFAULT_MAX_SIZE Default value of maximum size
static InMemoryFormat	DEFAULT_MEMORY_FORMAT Default memory format
static int	DEFAULT_TTL_SECONDS Default value of time to live in seconds.

Constructor Summary

Constructors

Constructor and Description
NearCacheConfig()
NearCacheConfig(int timeToLiveSeconds, int maxSize, String evictionPolicy, int maxIdleSeconds, boolean invalidateOnChange, InMemoryFormat inMemoryFormat)
NearCacheConfig(int timeToLiveSeconds, int maxSize, String evictionPolicy, int maxIdleSeconds, boolean invalidateOnChange, InMemoryFormat inMemoryFormat, EvictionConfig evictionConfig)
NearCacheConfig(NearCacheConfig config)
NearCacheConfig(String name)

Method Summary

Methods

Modifier and Type	Method and Description
NearCacheConfigReadOnly	getAsReadOnly()
EvictionConfig	getEvictionConfig() The eviction policy.
String	getEvictionPolicy() The eviction policy for the near cache.
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() Gets the maximum size of the near cache.
String	getName() Gets the name of the near cache.
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) The eviction policy.
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	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) 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.
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 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 idle in seconds for eviction.

See Also:

Constant Field Values

DEFAULT_MAX_SIZE

public static final int DEFAULT_MAX_SIZE

Default value of maximum size

See Also:

Constant Field Values

DEFAULT_EVICTION_POLICY

public static final String DEFAULT_EVICTION_POLICY

Default eviction policy

DEFAULT_MEMORY_FORMAT

public static final InMemoryFormat DEFAULT_MEMORY_FORMAT

Default memory format

Constructor Detail

NearCacheConfig

public NearCacheConfig()

NearCacheConfig

public NearCacheConfig(String name)

NearCacheConfig

public NearCacheConfig(int timeToLiveSeconds,
               int maxSize,
               String evictionPolicy,
               int maxIdleSeconds,
               boolean invalidateOnChange,
               InMemoryFormat inMemoryFormat)

NearCacheConfig

public NearCacheConfig(int timeToLiveSeconds,
               int maxSize,
               String evictionPolicy,
               int maxIdleSeconds,
               boolean invalidateOnChange,
               InMemoryFormat inMemoryFormat,
               EvictionConfig evictionConfig)

NearCacheConfig

public NearCacheConfig(NearCacheConfig config)

Method Detail

getAsReadOnly

public NearCacheConfigReadOnly getAsReadOnly()

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()

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)

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()

The eviction policy for the near cache. 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.

Returns:

TThe eviction policy for the near cache.

setEvictionPolicy

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

Returns:

The eviction policy.

setEvictionConfig

public NearCacheConfig setEvictionConfig(EvictionConfig evictionConfig)

The eviction policy. Valid values are: NONE (no extra eviction, time-to-live-seconds may still apply), LRU (Least Recently Used), LFU (Least Frequently Used). Regardless of the eviction policy used, time-to-live-seconds will still apply.

Parameters:

evictionConfig - The eviction policy.

Returns:

This near cache config instance.

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