org.redisson.api

Class LocalCachedMapOptions

java.lang.Object

org.redisson.api.LocalCachedMapOptions

public class LocalCachedMapOptions
extends Object

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalCachedMapOptions(LocalCachedMapOptions copy)

Method Summary

Modifier and Type	Method and Description
LocalCachedMapOptions	cacheSize(int cacheSize) Sets cache size.
static LocalCachedMapOptions	defaults() Creates a new instance of LocalCachedMapOptions with default options.
LocalCachedMapOptions	evictionPolicy(LocalCachedMapOptions.EvictionPolicy evictionPolicy) Sets eviction policy.
int	getCacheSize()
LocalCachedMapOptions.EvictionPolicy	getEvictionPolicy()
long	getMaxIdleInMillis()
long	getTimeToLiveInMillis()
LocalCachedMapOptions	invalidateEntryOnChange(boolean value) Sets entry invalidation behavior.
boolean	isInvalidateEntryOnChange()
LocalCachedMapOptions	maxIdle(long maxIdleInMillis) Sets max idle time in milliseconds for each map entry in cache.
LocalCachedMapOptions	maxIdle(long maxIdle, TimeUnit timeUnit) Sets max idle time for each map entry in cache.
LocalCachedMapOptions	timeToLive(long timeToLiveInMillis) Sets time to live in milliseconds for each map entry in cache.
LocalCachedMapOptions	timeToLive(long timeToLive, TimeUnit timeUnit) Sets time to live for each map entry in cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalCachedMapOptions

protected LocalCachedMapOptions(LocalCachedMapOptions copy)

Method Detail

defaults

public static LocalCachedMapOptions 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);
 

Returns:

LocalCachedMapOptions instance

isInvalidateEntryOnChange

public boolean isInvalidateEntryOnChange()

getEvictionPolicy

public LocalCachedMapOptions.EvictionPolicy getEvictionPolicy()

getCacheSize

public int getCacheSize()

getTimeToLiveInMillis

public long getTimeToLiveInMillis()

getMaxIdleInMillis

public long getMaxIdleInMillis()

cacheSize

public LocalCachedMapOptions cacheSize(int cacheSize)

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

Parameters:

cacheSize - - size of cache

Returns:

LocalCachedMapOptions instance

invalidateEntryOnChange

public LocalCachedMapOptions invalidateEntryOnChange(boolean value)

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 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.

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

Returns:

LocalCachedMapOptions instance

timeToLive

public LocalCachedMapOptions 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 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 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 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