Package org.redisson.api.options

Class MapCacheParams<K,V>

java.lang.Object

org.redisson.api.options.MapCacheParams<K,V>

Type Parameters:

K - type of key

V - type of value

All Implemented Interfaces:

CodecOptions<MapCacheOptions<K,V>,Codec>, ExMapOptions<MapCacheOptions<K,V>,K,V>, InvocationOptions<MapCacheOptions<K,V>>, MapCacheOptions<K,V>, ObjectParams

public final class MapCacheParams<K,V>
extends Object
implements MapCacheOptions<K,V>

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
MapCacheOptions<K,V>	codec(Codec codec)	Defines codec used for data stored in Redis
Codec	getCodec()
MapLoader<K,V>	getLoader()
MapLoaderAsync<K,V>	getLoaderAsync()
String	getName()
int	getRetryAttempts()
int	getRetryInterval()
int	getTimeout()
int	getWriteBehindBatchSize()
int	getWriteBehindDelay()
WriteMode	getWriteMode()
MapWriter<K,V>	getWriter()
MapWriterAsync<K,V>	getWriterAsync()
int	getWriteRetryAttempts()
long	getWriteRetryInterval()
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>	retryAttempts(int retryAttempts)	Defines command retry attempts.
MapCacheOptions<K,V>	retryInterval(Duration interval)	Defines time interval for another one attempt to send a Redis command if it hasn't already been sent.
MapCacheOptions<K,V>	timeout(Duration timeout)	Defines Redis server response timeout.
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(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>	writeRetryAttempts(int writerRetryAttempts)	Sets max retry attempts for RetryableMapWriter or RetryableMapWriterAsync
MapCacheOptions<K,V>	writeRetryInterval(Duration writerRetryInterval)	Sets write retry interval

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.api.options.CodecOptions

codec

Methods inherited from interface org.redisson.api.options.ExMapOptions

loader, loaderAsync, writeBehindBatchSize, writeBehindDelay, writeMode, writer, writerAsync, writeRetryAttempts, writeRetryInterval

Methods inherited from interface org.redisson.api.options.InvocationOptions

retryAttempts, retryInterval, timeout

Method Details

getName

public String getName()

removeEmptyEvictionTask

public MapCacheOptions<K,V> removeEmptyEvictionTask()

Description copied from interface: MapCacheOptions

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

Specified by:

removeEmptyEvictionTask in interface MapCacheOptions<K,V>

Returns:

MapCacheOptions instance

isRemoveEmptyEvictionTask

public boolean isRemoveEmptyEvictionTask()

writer

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

Description copied from interface: ExMapOptions

Defines MapWriter object which is invoked during write operation.

Specified by:

writer in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writer - object

Returns:

MapOptions instance

getWriter

public MapWriter<K,V> getWriter()

writerAsync

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

Description copied from interface: ExMapOptions

Defines MapWriterAsync object which is invoked during write operation.

Specified by:

writerAsync in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writer - object

Returns:

MapOptions instance

getWriterAsync

public MapWriterAsync<K,V> getWriterAsync()

writeBehindBatchSize

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

Description copied from interface: ExMapOptions

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

Default is 50

Specified by:

writeBehindBatchSize in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writeBehindBatchSize - size of batch

Returns:

MapOptions instance

getWriteBehindBatchSize

public int getWriteBehindBatchSize()

writeBehindDelay

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

Description copied from interface: ExMapOptions

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

Default is 1000 milliseconds

Specified by:

writeBehindDelay in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writeBehindDelay - delay in milliseconds

Returns:

MapOptions instance

getWriteBehindDelay

public int getWriteBehindDelay()

writeMode

public MapCacheOptions<K,V> writeMode(WriteMode writeMode)

Description copied from interface: ExMapOptions

Sets write mode.

Default is WriteMode.WRITE_THROUGH

Specified by:

writeMode in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writeMode - write mode

Returns:

MapOptions instance

getWriteMode

public WriteMode getWriteMode()

getWriteRetryAttempts

public int getWriteRetryAttempts()

writeRetryAttempts

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

Sets max retry attempts for RetryableMapWriter or RetryableMapWriterAsync

Specified by:

writeRetryAttempts in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writerRetryAttempts - object

Returns:

MapOptions instance

getWriteRetryInterval

public long getWriteRetryInterval()

writeRetryInterval

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

Description copied from interface: ExMapOptions

Sets write retry interval

Specified by:

writeRetryInterval in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writerRetryInterval - Duration

Returns:

MapOptions instance

loader

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

Sets MapLoader object.

Specified by:

loader in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

loader - object

Returns:

MapOptions instance

getLoader

public MapLoader<K,V> getLoader()

loaderAsync

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

Description copied from interface: ExMapOptions

Sets MapLoaderAsync object.

Specified by:

loaderAsync in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

loaderAsync - object

Returns:

MapOptions instance

getLoaderAsync

public MapLoaderAsync<K,V> getLoaderAsync()

codec

public MapCacheOptions<K,V> codec(Codec codec)

Description copied from interface: CodecOptions

Defines codec used for data stored in Redis

Specified by:

codec in interface CodecOptions<T extends InvocationOptions<T>,C>

Parameters:

codec - applied to object instance

Returns:

options object

timeout

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

Description copied from interface: InvocationOptions

Defines Redis server response timeout. Starts to countdown when a Redis command was successfully sent.

Default is the value specified for the same parameter in Redisson configuration

Specified by:

timeout in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

timeout - Redis server response timeout

Returns:

options instance

retryAttempts

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

Description copied from interface: InvocationOptions

Defines command retry attempts. Error is thrown if the Redis command can't be sent to Redis server after retryAttempts. But if it sent successfully then responseTimeout is started.

Default is the value specified for the same parameter in Redisson configuration

Specified by:

retryAttempts in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

retryAttempts - command retry attempts

Returns:

options instance

retryInterval

public MapCacheOptions<K,V> retryInterval(Duration interval)

Description copied from interface: InvocationOptions

Defines time interval for another one attempt to send a Redis command if it hasn't already been sent.

Specified by:

retryInterval in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

interval - retry time interval

Returns:

options instance

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface ObjectParams

getRetryAttempts

public int getRetryAttempts()

Specified by:

getRetryAttempts in interface ObjectParams

getRetryInterval

public int getRetryInterval()

Specified by:

getRetryInterval in interface ObjectParams

getCodec

public Codec getCodec()