org.redisson.api

Class LocalCachedMapOptions<K,V>

java.lang.Object

org.redisson.api.MapOptions<K,V>

org.redisson.api.LocalCachedMapOptions<K,V>

Type Parameters:

K - key type

V - value type

public class LocalCachedMapOptions<K,V>
extends MapOptions<K,V>

RLocalCachedMap options object. Used to specify RLocalCachedMap settings.

Author:

Nikita Koksharov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalCachedMapOptions.EvictionPolicy
static class	LocalCachedMapOptions.InvalidationPolicy

Nested classes/interfaces inherited from class org.redisson.api.MapOptions

MapOptions.WriteMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalCachedMapOptions()
protected	LocalCachedMapOptions(LocalCachedMapOptions<K,V> copy)

Method Summary

Modifier and Type	Method and Description
LocalCachedMapOptions<K,V>	cacheSize(int cacheSize) Sets cache size.
static <K,V> LocalCachedMapOptions<K,V>	defaults() Creates a new instance of LocalCachedMapOptions with default options.
LocalCachedMapOptions<K,V>	evictionPolicy(LocalCachedMapOptions.EvictionPolicy evictionPolicy) Sets eviction policy.
int	getCacheSize()
LocalCachedMapOptions.EvictionPolicy	getEvictionPolicy()
LocalCachedMapOptions.InvalidationPolicy	getInvalidationPolicy()
long	getMaxIdleInMillis()
long	getTimeToLiveInMillis()
LocalCachedMapOptions<K,V>	invalidateEntryOnChange(boolean value) Deprecated.
LocalCachedMapOptions<K,V>	invalidationPolicy(LocalCachedMapOptions.InvalidationPolicy invalidationPolicy) Sets entry invalidation policy.
LocalCachedMapOptions<K,V>	loader(MapLoader<K,V> loader) Sets MapLoader object.
LocalCachedMapOptions<K,V>	maxIdle(long maxIdleInMillis) Sets max idle time in milliseconds for each map entry in cache.
LocalCachedMapOptions<K,V>	maxIdle(long maxIdle, TimeUnit timeUnit) Sets max idle time for each map entry in cache.
LocalCachedMapOptions<K,V>	timeToLive(long timeToLiveInMillis) Sets time to live in milliseconds for each map entry in cache.
LocalCachedMapOptions<K,V>	timeToLive(long timeToLive, TimeUnit timeUnit) Sets time to live for each map entry in cache.
LocalCachedMapOptions<K,V>	writeBehindThreads(int writeBehindThreads) Sets threads amount used in write behind mode.
LocalCachedMapOptions<K,V>	writeMode(MapOptions.WriteMode writeMode) Sets write mode.
LocalCachedMapOptions<K,V>	writer(MapWriter<K,V> writer) Sets MapWriter object.

Methods inherited from class org.redisson.api.MapOptions

getLoader, getWriteBehindThreads, getWriteMode, getWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalCachedMapOptions

protected LocalCachedMapOptions()

LocalCachedMapOptions

protected LocalCachedMapOptions(LocalCachedMapOptions<K,V> copy)

Method Detail

defaults

public static <K,V> LocalCachedMapOptions<K,V> defaults()

Creates a new instance of LocalCachedMapOptions with default options.

This is equivalent to:

     new LocalCachedMapOptions()
      .cacheSize(0).timeToLive(0).maxIdle(0)
      .evictionPolicy(EvictionPolicy.NONE)
      .invalidateEntryOnChange(true);
 

Type Parameters:

K - key type

V - value type

Returns:

LocalCachedMapOptions instance

getEvictionPolicy

public LocalCachedMapOptions.EvictionPolicy getEvictionPolicy()

getCacheSize

public int getCacheSize()

getTimeToLiveInMillis

public long getTimeToLiveInMillis()

getMaxIdleInMillis

public long getMaxIdleInMillis()

cacheSize

public LocalCachedMapOptions<K,V> cacheSize(int cacheSize)

Sets cache size. If size is 0 then local cache is unbounded.

Parameters:

cacheSize - - size of cache

Returns:

LocalCachedMapOptions instance

getInvalidationPolicy

public LocalCachedMapOptions.InvalidationPolicy getInvalidationPolicy()

invalidationPolicy

public LocalCachedMapOptions<K,V> invalidationPolicy(LocalCachedMapOptions.InvalidationPolicy invalidationPolicy)

Sets entry invalidation policy.

Parameters:

invalidationPolicy -

NONE - no invalidation applied.

ON_CHANGE - invalidation message which removes corresponding entry from cache will be sent to all other RLocalCachedMap instances on each entry update/remove operation.

ON_CHANGE_WITH_CLEAR_ON_RECONNECT - includes ON_CHANGE policy and clears local cache of current instance in case of reconnection to Redis.

Returns:

LocalCachedMapOptions instance

invalidateEntryOnChange

@Deprecated
public LocalCachedMapOptions<K,V> invalidateEntryOnChange(boolean value)

Deprecated.

Sets entry invalidation behavior.

Parameters:

value - - if true then invalidation message which removes corresponding entry from cache will be sent to all other RLocalCachedMap instances on each entry update/remove operation. if false then invalidation message won't be sent

Returns:

LocalCachedMapOptions instance

evictionPolicy

public LocalCachedMapOptions<K,V> evictionPolicy(LocalCachedMapOptions.EvictionPolicy evictionPolicy)

Sets eviction policy.

Parameters:

evictionPolicy -

LRU - uses cache with LRU (least recently used) eviction policy.

LFU - uses cache with LFU (least frequently used) eviction policy.

SOFT - uses cache with soft references. The garbage collector will evict items from the cache when the JVM is running out of memory.

NONE - doesn't use eviction policy, but timeToLive and maxIdleTime params are still working.

Returns:

LocalCachedMapOptions instance

timeToLive

public LocalCachedMapOptions<K,V> timeToLive(long timeToLiveInMillis)

Sets time to live in milliseconds for each map entry in cache. If value equals to 0 then timeout is not applied

Parameters:

timeToLiveInMillis - - time to live in milliseconds

Returns:

LocalCachedMapOptions instance

timeToLive

public LocalCachedMapOptions<K,V> timeToLive(long timeToLive,
                                             TimeUnit timeUnit)

Sets time to live for each map entry in cache. If value equals to 0 then timeout is not applied

Parameters:

timeToLive - - time to live

timeUnit - - time unit

Returns:

LocalCachedMapOptions instance

maxIdle

public LocalCachedMapOptions<K,V> maxIdle(long maxIdleInMillis)

Sets max idle time in milliseconds for each map entry in cache. If value equals to 0 then timeout is not applied

Parameters:

maxIdleInMillis - - time to live in milliseconds

Returns:

LocalCachedMapOptions instance

maxIdle

public LocalCachedMapOptions<K,V> maxIdle(long maxIdle,
                                          TimeUnit timeUnit)

Sets max idle time for each map entry in cache. If value equals to 0 then timeout is not applied

Parameters:

maxIdle - - max idle time

timeUnit - - time unit

Returns:

LocalCachedMapOptions instance

writer

public LocalCachedMapOptions<K,V> writer(MapWriter<K,V> writer)

Description copied from class: MapOptions

Sets MapWriter object.

Overrides:

writer in class MapOptions<K,V>

Parameters:

writer - object

Returns:

MapOptions instance

writeBehindThreads

public LocalCachedMapOptions<K,V> writeBehindThreads(int writeBehindThreads)

Description copied from class: MapOptions

Sets threads amount used in write behind mode.

Default is 1

Overrides:

writeBehindThreads in class MapOptions<K,V>

Parameters:

writeBehindThreads - - threads amount

Returns:

MapOptions instance

writeMode

public LocalCachedMapOptions<K,V> writeMode(MapOptions.WriteMode writeMode)

Description copied from class: MapOptions

Sets write mode.

Default is MapOptions.WriteMode.WRITE_THROUGH

Overrides:

writeMode in class MapOptions<K,V>

Parameters:

writeMode - - write mode

Returns:

MapOptions instance

loader

public LocalCachedMapOptions<K,V> loader(MapLoader<K,V> loader)

Description copied from class: MapOptions

Sets MapLoader object.

Overrides:

loader in class MapOptions<K,V>

Parameters:

loader - object

Returns:

MapOptions instance