Package org.redisson.api

Class MapCacheOptions<K,V>

java.lang.Object

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

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

Type Parameters:

K - key type

V - value type

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

Configuration for RMapCache object.

Author:

Nikita Koksharov

Nested Class Summary

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

MapOptions.WriteMode

Constructor Summary

Constructors

Constructor	Description
MapCacheOptions()

Method Summary

Modifier and Type	Method	Description
static <K, V> MapCacheOptions<K,V>	defaults()
boolean	isRemoveEmptyEvictionTask()
MapCacheOptions<K,V>	loader(MapLoader<K,V> loader)	Sets MapLoader object.
MapCacheOptions<K,V>	loaderAsync(MapLoaderAsync<K,V> loaderAsync)	Sets MapLoaderAsync object.
MapCacheOptions<K,V>	removeEmptyEvictionTask()	Removes eviction task from memory if map is empty upon entries eviction process completion.
MapCacheOptions<K,V>	writeBehindBatchSize(int writeBehindBatchSize)	Sets write behind tasks batch size.
MapCacheOptions<K,V>	writeBehindDelay(int writeBehindDelay)	Sets write behind tasks execution delay.
MapCacheOptions<K,V>	writeMode(MapOptions.WriteMode writeMode)	Sets write mode.
MapCacheOptions<K,V>	writer(MapWriter<K,V> writer)	Defines MapWriter object which is invoked during write operation.
MapCacheOptions<K,V>	writerAsync(MapWriterAsync<K,V> writer)	Defines MapWriterAsync object which is invoked during write operation.
MapCacheOptions<K,V>	writerRetryAttempts(int writerRetryAttempts)	Sets max retry attempts for RetryableMapWriter or RetryableMapWriterAsync
MapCacheOptions<K,V>	writerRetryInterval(Duration writerRetryInterval)	Sets retry interval for RetryableMapWriter or RetryableMapWriterAsync

Methods inherited from class org.redisson.api.MapOptions

getLoader, getLoaderAsync, getWriteBehindBatchSize, getWriteBehindDelay, getWriteMode, getWriter, getWriterAsync, getWriterRetryAttempts, getWriterRetryInterval

Methods inherited from class java.lang.Object

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

Constructor Details

MapCacheOptions

public MapCacheOptions()

Method Details

defaults

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

writer

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

Description copied from class: MapOptions

Defines MapWriter object which is invoked during write operation.

Overrides:

writer in class MapOptions<K,V>

Parameters:

writer - object

Returns:

MapOptions instance

writerAsync

public MapCacheOptions<K,V> writerAsync(MapWriterAsync<K,V> writer)

Description copied from class: MapOptions

Defines MapWriterAsync object which is invoked during write operation.

Overrides:

writerAsync in class MapOptions<K,V>

Parameters:

writer - object

Returns:

MapOptions instance

writeBehindBatchSize

public MapCacheOptions<K,V> writeBehindBatchSize(int writeBehindBatchSize)

Description copied from class: MapOptions

Sets write behind tasks batch size. All updates accumulated into a batch of specified size and written with MapWriter.

Default is 50

Overrides:

writeBehindBatchSize in class MapOptions<K,V>

Parameters:

writeBehindBatchSize - - size of batch

Returns:

MapOptions instance

writeBehindDelay

public MapCacheOptions<K,V> writeBehindDelay(int writeBehindDelay)

Description copied from class: MapOptions

Sets write behind tasks execution delay. All updates written with MapWriter and lag not more than specified delay.

Default is 1000 milliseconds

Overrides:

writeBehindDelay in class MapOptions<K,V>

Parameters:

writeBehindDelay - - delay in milliseconds

Returns:

MapOptions instance

writeMode

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

loaderAsync

public MapCacheOptions<K,V> loaderAsync(MapLoaderAsync<K,V> loaderAsync)

Description copied from class: MapOptions

Sets MapLoaderAsync object.

Overrides:

loaderAsync in class MapOptions<K,V>

Parameters:

loaderAsync - object

Returns:

MapOptions instance

writerRetryAttempts

public MapCacheOptions<K,V> writerRetryAttempts(int writerRetryAttempts)

Description copied from class: MapOptions

Sets max retry attempts for RetryableMapWriter or RetryableMapWriterAsync

Overrides:

writerRetryAttempts in class MapOptions<K,V>

Parameters:

writerRetryAttempts - object

Returns:

MapOptions instance

writerRetryInterval

public MapCacheOptions<K,V> writerRetryInterval(Duration writerRetryInterval)

Description copied from class: MapOptions

Sets retry interval for RetryableMapWriter or RetryableMapWriterAsync

Overrides:

writerRetryInterval in class MapOptions<K,V>

Parameters:

writerRetryInterval - Duration

Returns:

MapOptions instance

isRemoveEmptyEvictionTask

public boolean isRemoveEmptyEvictionTask()

removeEmptyEvictionTask

public MapCacheOptions<K,V> removeEmptyEvictionTask()

Removes eviction task from memory if map is empty upon entries eviction process completion.

Returns:

MapOptions instance