Package org.redisson

Class RedissonLocalCachedMap<K,V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonMap<K,V>

org.redisson.RedissonLocalCachedMap<K,V>

All Implemented Interfaces:

ConcurrentMap<K,V>, Map<K,V>, RDestroyable, RExpirable, RExpirableAsync, RLocalCachedMap<K,V>, RMap<K,V>, RMapAsync<K,V>, RObject, RObjectAsync

public class RedissonLocalCachedMap<K,V>
extends RedissonMap<K,V>
implements RLocalCachedMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static String	DISABLED_ACK_SUFFIX
static String	DISABLED_KEYS_SUFFIX
static String	TOPIC_SUFFIX

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor, name

Constructor Summary

Constructors

Constructor	Description
RedissonLocalCachedMap(Codec codec, CommandAsyncExecutor connectionManager, String name, LocalCachedMapOptions<K,V> options, EvictionScheduler evictionScheduler, RedissonClient redisson, WriteBehindService writeBehindService)
RedissonLocalCachedMap(CommandAsyncExecutor commandExecutor, String name, LocalCachedMapOptions<K,V> options, EvictionScheduler evictionScheduler, RedissonClient redisson, WriteBehindService writeBehindService)

Method Summary

Modifier and Type	Method	Description
protected RFuture<V>	addAndGetOperationAsync(K key, Number value)
Set<Map.Entry<K,V>>	cachedEntrySet()	Returns all map entries stored in local cache
Set<K>	cachedKeySet()	Returns all keys stored in local cache
Collection<V>	cachedValues()	Returns all values stored in local cache
boolean	clearExpire()	Clear an expire timeout or expire date for object.
RFuture<Boolean>	clearExpireAsync()	Clear an expire timeout or expire date for object in async mode.
protected RFuture<Boolean>	clearExpireAsync(String... keys)
void	clearLocalCache()	Clears local cache across all instances
RFuture<Void>	clearLocalCacheAsync()	Clears local cache across all instances
RFuture<Boolean>	containsKeyAsync(Object key)	Returns true if this map contains map entry mapped by specified key, otherwise false
RFuture<Boolean>	containsValueAsync(Object value)	Returns true if this map contains any map entry with specified value, otherwise false
protected io.netty.buffer.ByteBuf	createSyncMessage(io.netty.buffer.ByteBuf mapKey, io.netty.buffer.ByteBuf mapValue, CacheKey cacheKey)
RFuture<Boolean>	deleteAsync()	Delete object in async mode
void	destroy()	Destroys object when it's not necessary anymore.
io.netty.buffer.ByteBuf	encode(Object value)
boolean	expire(long timeToLive, TimeUnit timeUnit)	Use RExpirable.expire(Duration) instead
boolean	expire(Duration duration)	Sets a timeout for this object.
boolean	expire(Instant instant)	Sets an expiration date for this object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit)	Use RExpirableAsync.expireAsync(Duration) instead
protected RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit, String param, String... keys)
RFuture<Boolean>	expireAsync(Duration duration)	Set a timeout for object.
RFuture<Boolean>	expireAsync(Instant instant)	Set an expire date for object.
boolean	expireAt(long timestamp)	Use RExpirable.expire(Instant) instead
boolean	expireAt(Date timestamp)	Use RExpirable.expire(Instant) instead
RFuture<Boolean>	expireAtAsync(long timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
protected RFuture<Boolean>	expireAtAsync(long timestamp, String param, String... keys)
RFuture<Boolean>	expireAtAsync(Date timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
boolean	expireIfGreater(Duration duration)	Sets a timeout for this object only if it's greater than timeout set before.
boolean	expireIfGreater(Instant time)	Sets an expiration date for this object only if it's greater than expiration date set before.
RFuture<Boolean>	expireIfGreaterAsync(Duration duration)
RFuture<Boolean>	expireIfGreaterAsync(Instant time)
boolean	expireIfLess(Duration duration)	Sets a timeout for this object only if it's less than timeout set before.
boolean	expireIfLess(Instant time)	Sets an expiration date for this object only if it's less than expiration date set before.
RFuture<Boolean>	expireIfLessAsync(Duration duration)
RFuture<Boolean>	expireIfLessAsync(Instant time)
boolean	expireIfNotSet(Duration duration)	Sets a timeout for this object only if it hasn't been set before.
boolean	expireIfNotSet(Instant time)	Sets an expiration date for this object only if it hasn't been set before.
RFuture<Boolean>	expireIfNotSetAsync(Duration duration)
RFuture<Boolean>	expireIfNotSetAsync(Instant time)
boolean	expireIfSet(Duration duration)	Sets a timeout for this object only if it has been already set.
boolean	expireIfSet(Instant time)	Sets an expiration date for this object only if it has been already set.
RFuture<Boolean>	expireIfSetAsync(Duration duration)
RFuture<Boolean>	expireIfSetAsync(Instant time)
RFuture<Boolean>	fastPutIfAbsentAsync(K key, V value)	Stores the specified value mapped by specified key only if there is no value with specifiedkey stored before.
RFuture<Boolean>	fastPutIfExistsAsync(K key, V value)	Stores the specified value mapped by key only if mapping already exists.
protected RFuture<Boolean>	fastPutOperationAsync(K key, V value)
protected RFuture<Long>	fastRemoveOperationAsync(K... keys)
protected RFuture<List<Long>>	fastRemoveOperationBatchAsync(K... keys)
RFuture<Boolean>	fastReplaceAsync(K key, V value)	Replaces previous value with a new value mapped by specified key.
protected RFuture<Boolean>	fastReplaceOperationAsync(K key, V value)
protected static byte[]	generateLogEntryId(byte[] keyHash)
RFuture<Map<K,V>>	getAllAsync(Set<K> keys)	Returns map slice contained the mappings with defined keys.
RFuture<V>	getAsync(Object key)	Returns the value mapped by defined key or null if value is absent.
Map<K,V>	getCachedMap()	Returns state of local cache
long	getExpireTime()	Expiration time of Redisson object that has a timeout
RFuture<Long>	getExpireTimeAsync()	Expiration time of Redisson object that has a timeout
LocalCacheView<K,V>	getLocalCacheView()
void	preloadCache()	Pre-warm the cached entries.
void	preloadCache(int count)	Pre-warm the cached entries.
protected RFuture<Void>	putAllOperationAsync(Map<? extends K,? extends V> map)
RFuture<V>	putIfAbsentAsync(K key, V value)	Stores the specified value mapped by specified key only if there is no value with specifiedkey stored before.
RFuture<V>	putIfExistsAsync(K key, V value)	Stores the specified value mapped by key only if mapping already exists.
protected RFuture<V>	putOperationAsync(K key, V value)
RFuture<Set<Map.Entry<K,V>>>	readAllEntrySetAsync()	Read all map entries at once
RFuture<Map<K,V>>	readAllMapAsync()	Read all map as local instance at once
RFuture<Collection<V>>	readAllValuesAsync()	Read all values at once
long	remainTimeToLive()	Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync()	Remaining time to live of Redisson object that has a timeout
RFuture<Boolean>	removeAsync(Object key, Object value)	Removes map entry only if it exists with specified key and value.
protected RFuture<Boolean>	removeOperationAsync(Object key, Object value)
protected RFuture<V>	removeOperationAsync(K key)
RFuture<V>	replaceAsync(K key, V value)	Replaces previous value with a new value mapped by specified key.
RFuture<Boolean>	replaceAsync(K key, V oldValue, V newValue)	Replaces previous oldValue with a newValue mapped by specified key.
protected RFuture<V>	replaceOperationAsync(K key, V value)
protected RFuture<Boolean>	replaceOperationAsync(K key, V oldValue, V newValue)
RFuture<Integer>	sizeAsync()	Returns size of this map
RFuture<Long>	sizeInMemoryAsync()	Returns bytes amount used by object in Redis memory.

Methods inherited from class org.redisson.RedissonMap

addAndGet, addAndGetAsync, checkKey, checkValue, clear, compute, computeAsync, computeIfAbsent, computeIfAbsentAsync, computeIfPresent, computeIfPresentAsync, containsKey, containsKeyAsync, containsKeyOperationAsync, containsValue, entryIterator, entrySet, entrySet, entrySet, entrySet, equals, fastPut, fastPutAsync, fastPutIfAbsent, fastPutIfAbsentOperationAsync, fastPutIfExists, fastPutIfExistsOperationAsync, fastRemove, fastRemoveAsync, fastReplace, get, getAll, getAllOperationAsync, getCountDownLatch, getFairLock, getLock, getOperationAsync, getPermitExpirableSemaphore, getReadWriteLock, getSemaphore, hashCode, hasNoLoader, hasNoWriter, isEmpty, keyIterator, keySet, keySet, keySet, keySet, loadAll, loadAll, loadAllAsync, loadAllAsync, loadAllAsync, loadValue, mapReduce, mapWriterFuture, mapWriterFuture, merge, mergeAsync, put, putAll, putAll, putAllAsync, putAllAsync, putAsync, putIfAbsent, putIfAbsentOperationAsync, putIfExists, putIfExistsOperationAsync, randomEntries, randomEntriesAsync, randomKeys, randomKeysAsync, readAllEntrySet, readAllKeySet, readAllKeySetAsync, readAllMap, readAllValues, remove, remove, removeAsync, replace, replace, scanIterator, scanIteratorAsync, size, valueIterator, values, values, values, values, valueSize, valueSizeAsync

Methods inherited from class org.redisson.RedissonObject

addListener, addListener, addListenerAsync, addListenerAsync, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, removeListener, removeListenerAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.ConcurrentMap

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, replaceAll

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, size

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expire, expireAt, expireAt, expireIfGreater, expireIfGreater, expireIfLess, expireIfLess, expireIfNotSet, expireIfNotSet, expireIfSet, expireIfSet, getExpireTime, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, expireIfGreaterAsync, expireIfGreaterAsync, expireIfLessAsync, expireIfLessAsync, expireIfNotSetAsync, expireIfNotSetAsync, expireIfSetAsync, expireIfSetAsync, getExpireTimeAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RMap

addAndGet, containsKey, containsValue, entrySet, entrySet, entrySet, entrySet, fastPut, fastPutIfAbsent, fastPutIfExists, fastRemove, fastReplace, get, getAll, getCountDownLatch, getFairLock, getLock, getPermitExpirableSemaphore, getReadWriteLock, getSemaphore, keySet, keySet, keySet, keySet, loadAll, loadAll, mapReduce, put, putAll, putAll, putIfAbsent, putIfExists, randomEntries, randomKeys, readAllEntrySet, readAllKeySet, readAllMap, readAllValues, remove, remove, replace, replace, values, values, values, values, valueSize

Methods inherited from interface org.redisson.api.RMapAsync

addAndGetAsync, computeAsync, computeIfAbsentAsync, computeIfPresentAsync, fastPutAsync, fastRemoveAsync, loadAllAsync, loadAllAsync, mergeAsync, putAllAsync, putAllAsync, putAsync, randomEntriesAsync, randomKeysAsync, readAllKeySetAsync, removeAsync, valueSizeAsync

Methods inherited from interface org.redisson.api.RObject

addListener, copy, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Methods inherited from interface org.redisson.api.RObjectAsync

addListenerAsync, copyAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, touchAsync, unlinkAsync

Field Detail

TOPIC_SUFFIX

public static final String TOPIC_SUFFIX

See Also:

Constant Field Values

DISABLED_KEYS_SUFFIX

public static final String DISABLED_KEYS_SUFFIX

See Also:

Constant Field Values

DISABLED_ACK_SUFFIX

public static final String DISABLED_ACK_SUFFIX

See Also:

Constant Field Values

Constructor Detail

RedissonLocalCachedMap

public RedissonLocalCachedMap(CommandAsyncExecutor commandExecutor,
                              String name,
                              LocalCachedMapOptions<K,V> options,
                              EvictionScheduler evictionScheduler,
                              RedissonClient redisson,
                              WriteBehindService writeBehindService)

RedissonLocalCachedMap

public RedissonLocalCachedMap(Codec codec,
                              CommandAsyncExecutor connectionManager,
                              String name,
                              LocalCachedMapOptions<K,V> options,
                              EvictionScheduler evictionScheduler,
                              RedissonClient redisson,
                              WriteBehindService writeBehindService)

Method Detail

getLocalCacheView

public LocalCacheView<K,V> getLocalCacheView()

sizeAsync

public RFuture<Integer> sizeAsync()

Description copied from interface: RMapAsync

Returns size of this map

Specified by:

sizeAsync in interface RMapAsync<K,V>

Overrides:

sizeAsync in class RedissonMap<K,V>

Returns:

size

containsKeyAsync

public RFuture<Boolean> containsKeyAsync(Object key)

Description copied from interface: RMapAsync

Returns true if this map contains map entry mapped by specified key, otherwise false

Specified by:

containsKeyAsync in interface RMapAsync<K,V>

Overrides:

containsKeyAsync in class RedissonMap<K,V>

Parameters:

key - - map key

Returns:

true if this map contains map entry mapped by specified key, otherwise false

containsValueAsync

public RFuture<Boolean> containsValueAsync(Object value)

Description copied from interface: RMapAsync

Returns true if this map contains any map entry with specified value, otherwise false

Specified by:

containsValueAsync in interface RMapAsync<K,V>

Overrides:

containsValueAsync in class RedissonMap<K,V>

Parameters:

value - - map value

Returns:

true if this map contains any map entry with specified value, otherwise false

getAsync

public RFuture<V> getAsync(Object key)

Description copied from interface: RMapAsync

Returns the value mapped by defined key or null if value is absent.

If map doesn't contain value for specified key and MapLoader is defined then value will be loaded in read-through mode.

Specified by:

getAsync in interface RMapAsync<K,V>

Overrides:

getAsync in class RedissonMap<K,V>

Parameters:

key - the key

Returns:

the value mapped by defined key or null if value is absent

generateLogEntryId

protected static byte[] generateLogEntryId(byte[] keyHash)

putOperationAsync

protected RFuture<V> putOperationAsync(K key,
                                       V value)

Overrides:

putOperationAsync in class RedissonMap<K,V>

createSyncMessage

protected io.netty.buffer.ByteBuf createSyncMessage(io.netty.buffer.ByteBuf mapKey,
                                                    io.netty.buffer.ByteBuf mapValue,
                                                    CacheKey cacheKey)

fastPutOperationAsync

protected RFuture<Boolean> fastPutOperationAsync(K key,
                                                 V value)

Overrides:

fastPutOperationAsync in class RedissonMap<K,V>

destroy

public void destroy()

Description copied from interface: RDestroyable

Destroys object when it's not necessary anymore.

Specified by:

destroy in interface RDestroyable

removeOperationAsync

protected RFuture<V> removeOperationAsync(K key)

Overrides:

removeOperationAsync in class RedissonMap<K,V>

fastRemoveOperationBatchAsync

protected RFuture<List<Long>> fastRemoveOperationBatchAsync(K... keys)

Overrides:

fastRemoveOperationBatchAsync in class RedissonMap<K,V>

fastRemoveOperationAsync

protected RFuture<Long> fastRemoveOperationAsync(K... keys)

Overrides:

fastRemoveOperationAsync in class RedissonMap<K,V>

sizeInMemoryAsync

public RFuture<Long> sizeInMemoryAsync()

Description copied from interface: RObjectAsync

Returns bytes amount used by object in Redis memory.

Specified by:

sizeInMemoryAsync in interface RObjectAsync

Overrides:

sizeInMemoryAsync in class RedissonObject

Returns:

size in bytes

deleteAsync

public RFuture<Boolean> deleteAsync()

Description copied from interface: RObjectAsync

Delete object in async mode

Specified by:

deleteAsync in interface RObjectAsync

Overrides:

deleteAsync in class RedissonObject

Returns:

true if object was deleted false if not

getAllAsync

public RFuture<Map<K,V>> getAllAsync(Set<K> keys)

Description copied from interface: RMapAsync

Returns map slice contained the mappings with defined keys.

If map doesn't contain value/values for specified key/keys and MapLoader is defined then value/values will be loaded in read-through mode.

The returned map is NOT backed by the original map.

Specified by:

getAllAsync in interface RMapAsync<K,V>

Overrides:

getAllAsync in class RedissonMap<K,V>

Parameters:

keys - - map keys

Returns:

Map slice

putAllOperationAsync

protected RFuture<Void> putAllOperationAsync(Map<? extends K,? extends V> map)

Overrides:

putAllOperationAsync in class RedissonMap<K,V>

addAndGetOperationAsync

protected RFuture<V> addAndGetOperationAsync(K key,
                                             Number value)

Overrides:

addAndGetOperationAsync in class RedissonMap<K,V>

fastPutIfAbsentAsync

public RFuture<Boolean> fastPutIfAbsentAsync(K key,
                                             V value)

Description copied from interface: RMapAsync

Stores the specified value mapped by specified key only if there is no value with specifiedkey stored before.

Returns true if key is a new one in the hash and value was set or false if key already exists in the hash and change hasn't been made.

Works faster than RMapAsync.putIfAbsentAsync(Object, Object) but not returning the previous value associated with key

If MapWriter is defined then new map entry is stored in write-through mode.

Specified by:

fastPutIfAbsentAsync in interface RMapAsync<K,V>

Overrides:

fastPutIfAbsentAsync in class RedissonMap<K,V>

Parameters:

key - - map key

value - - map value

Returns:

true if key is a new one in the hash and value was set. false if key already exists in the hash and change hasn't been made.

fastPutIfExistsAsync

public RFuture<Boolean> fastPutIfExistsAsync(K key,
                                             V value)

Description copied from interface: RMapAsync

Stores the specified value mapped by key only if mapping already exists.

Returns true if key is a new one in the hash and value was set or false if key already exists in the hash and change hasn't been made.

Works faster than RMapAsync.putIfExistsAsync(Object, Object) but doesn't return previous value associated with key

If MapWriter is defined then new map entry is stored in write-through mode.

Specified by:

fastPutIfExistsAsync in interface RMapAsync<K,V>

Overrides:

fastPutIfExistsAsync in class RedissonMap<K,V>

Parameters:

key - - map key

value - - map value

Returns:

true if key already exists in the hash and new value has been stored. false if key doesn't exist in the hash and value hasn't been set.

readAllValuesAsync

public RFuture<Collection<V>> readAllValuesAsync()

Description copied from interface: RMapAsync

Read all values at once

Specified by:

readAllValuesAsync in interface RMapAsync<K,V>

Overrides:

readAllValuesAsync in class RedissonMap<K,V>

Returns:

values

readAllMapAsync

public RFuture<Map<K,V>> readAllMapAsync()

Description copied from interface: RMapAsync

Read all map as local instance at once

Specified by:

readAllMapAsync in interface RMapAsync<K,V>

Overrides:

readAllMapAsync in class RedissonMap<K,V>

Returns:

map

preloadCache

public void preloadCache()

Description copied from interface: RLocalCachedMap

Pre-warm the cached entries. Not guaranteed to load ALL values, but statistically will preload approximately all (all if no concurrent mutating activity). Entries are loaded in a batch with size of 10 elements.

Specified by:

preloadCache in interface RLocalCachedMap<K,V>

preloadCache

public void preloadCache(int count)

Description copied from interface: RLocalCachedMap

Pre-warm the cached entries. Not guaranteed to load ALL values, but statistically will preload approximately all (all if no concurrent mutating activity) Entries are loaded in a batch. Batch size is defined by count param.

Specified by:

preloadCache in interface RLocalCachedMap<K,V>

Parameters:

count - - size of batch

clearLocalCache

public void clearLocalCache()

Description copied from interface: RLocalCachedMap

Clears local cache across all instances

Specified by:

clearLocalCache in interface RLocalCachedMap<K,V>

clearLocalCacheAsync

public RFuture<Void> clearLocalCacheAsync()

Description copied from interface: RLocalCachedMap

Clears local cache across all instances

Specified by:

clearLocalCacheAsync in interface RLocalCachedMap<K,V>

Returns:

void

readAllEntrySetAsync

public RFuture<Set<Map.Entry<K,V>>> readAllEntrySetAsync()

Description copied from interface: RMapAsync

Read all map entries at once

Specified by:

readAllEntrySetAsync in interface RMapAsync<K,V>

Overrides:

readAllEntrySetAsync in class RedissonMap<K,V>

Returns:

entries

fastReplaceAsync

public RFuture<Boolean> fastReplaceAsync(K key,
                                         V value)

Description copied from interface: RMapAsync

Replaces previous value with a new value mapped by specified key.

Works faster than RMapAsync.replaceAsync(Object, Object) but not returning the previous value.

Returns true if key exists and value was updated or false if key doesn't exists and value wasn't updated.

If MapWriter is defined then new map entry is stored in write-through mode.

Specified by:

fastReplaceAsync in interface RMapAsync<K,V>

Overrides:

fastReplaceAsync in class RedissonMap<K,V>

Parameters:

key - - map key

value - - map value

Returns:

true if key exists and value was updated. false if key doesn't exists and value wasn't updated.

fastReplaceOperationAsync

protected RFuture<Boolean> fastReplaceOperationAsync(K key,
                                                     V value)

Overrides:

fastReplaceOperationAsync in class RedissonMap<K,V>

replaceOperationAsync

protected RFuture<V> replaceOperationAsync(K key,
                                           V value)

Overrides:

replaceOperationAsync in class RedissonMap<K,V>

replaceAsync

public RFuture<V> replaceAsync(K key,
                               V value)

Description copied from interface: RMapAsync

Replaces previous value with a new value mapped by specified key. Returns null if there is no map entry stored before and doesn't store new map entry.

If MapWriter is defined then new valueis written in write-through mode.

Specified by:

replaceAsync in interface RMapAsync<K,V>

Overrides:

replaceAsync in class RedissonMap<K,V>

Parameters:

key - - map key

value - - map value

Returns:

previous associated value or null if there is no map entry stored before and doesn't store new map entry

replaceOperationAsync

protected RFuture<Boolean> replaceOperationAsync(K key,
                                                 V oldValue,
                                                 V newValue)

Overrides:

replaceOperationAsync in class RedissonMap<K,V>

replaceAsync

public RFuture<Boolean> replaceAsync(K key,
                                     V oldValue,
                                     V newValue)

Description copied from interface: RMapAsync

Replaces previous oldValue with a newValue mapped by specified key. Returns false if previous value doesn't exist or equal to oldValue.

If MapWriter is defined then newValueis written in write-through mode.

Specified by:

replaceAsync in interface RMapAsync<K,V>

Overrides:

replaceAsync in class RedissonMap<K,V>

Parameters:

key - - map key

oldValue - - map old value

newValue - - map new value

Returns:

true if value has been replaced otherwise false.

removeOperationAsync

protected RFuture<Boolean> removeOperationAsync(Object key,
                                                Object value)

Overrides:

removeOperationAsync in class RedissonMap<K,V>

removeAsync

public RFuture<Boolean> removeAsync(Object key,
                                    Object value)

Description copied from interface: RMapAsync

Removes map entry only if it exists with specified key and value.

If MapWriter is defined then keyis deleted in write-through mode.

Specified by:

removeAsync in interface RMapAsync<K,V>

Overrides:

removeAsync in class RedissonMap<K,V>

Parameters:

key - - map key

value - - map value

Returns:

true if map entry has been removed otherwise false.

putIfExistsAsync

public RFuture<V> putIfExistsAsync(K key,
                                   V value)

Description copied from interface: RMapAsync

Stores the specified value mapped by key only if mapping already exists.

If MapWriter is defined then new map entry is stored in write-through mode.

Specified by:

putIfExistsAsync in interface RMapAsync<K,V>

Overrides:

putIfExistsAsync in class RedissonMap<K,V>

Parameters:

key - - map key

value - - map value

Returns:

null if key is doesn't exists in the hash and value hasn't been set. Previous value if key already exists in the hash and new value has been stored.

putIfAbsentAsync

public RFuture<V> putIfAbsentAsync(K key,
                                   V value)

Description copied from interface: RMapAsync

Stores the specified value mapped by specified key only if there is no value with specifiedkey stored before.

If MapWriter is defined then new map entry is stored in write-through mode.

Specified by:

putIfAbsentAsync in interface RMapAsync<K,V>

Overrides:

putIfAbsentAsync in class RedissonMap<K,V>

Parameters:

key - - map key

value - - map value

Returns:

null if key is a new one in the hash and value was set. Previous value if key already exists in the hash and change hasn't been made.

encode

public io.netty.buffer.ByteBuf encode(Object value)

Overrides:

encode in class RedissonObject

cachedKeySet

public Set<K> cachedKeySet()

Description copied from interface: RLocalCachedMap

Returns all keys stored in local cache

Specified by:

cachedKeySet in interface RLocalCachedMap<K,V>

Returns:

keys

cachedValues

public Collection<V> cachedValues()

Description copied from interface: RLocalCachedMap

Returns all values stored in local cache

Specified by:

cachedValues in interface RLocalCachedMap<K,V>

Returns:

values

cachedEntrySet

public Set<Map.Entry<K,V>> cachedEntrySet()

Description copied from interface: RLocalCachedMap

Returns all map entries stored in local cache

Specified by:

cachedEntrySet in interface RLocalCachedMap<K,V>

Returns:

entries

getCachedMap

public Map<K,V> getCachedMap()

Description copied from interface: RLocalCachedMap

Returns state of local cache

Specified by:

getCachedMap in interface RLocalCachedMap<K,V>

Returns:

map

expire

public boolean expire(long timeToLive,
                      TimeUnit timeUnit)

Description copied from interface: RExpirable

Use RExpirable.expire(Duration) instead

Specified by:

expire in interface RExpirable

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(long timeToLive,
                                    TimeUnit timeUnit)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Duration) instead

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(long timestamp)

Description copied from interface: RExpirable

Use RExpirable.expire(Instant) instead

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(long timestamp)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expire

public boolean expire(Instant instant)

Description copied from interface: RExpirable

Sets an expiration date for this object. When expire date comes the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

instant - expire date

Returns:

true if the timeout was set and false if not

expireIfSet

public boolean expireIfSet(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSet in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfSetAsync

public RFuture<Boolean> expireIfSetAsync(Instant time)

Specified by:

expireIfSetAsync in interface RExpirableAsync

expireIfNotSet

public boolean expireIfNotSet(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSet in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfNotSetAsync

public RFuture<Boolean> expireIfNotSetAsync(Instant time)

Specified by:

expireIfNotSetAsync in interface RExpirableAsync

expireIfGreater

public boolean expireIfGreater(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreater in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfGreaterAsync

public RFuture<Boolean> expireIfGreaterAsync(Instant time)

Specified by:

expireIfGreaterAsync in interface RExpirableAsync

expireIfLess

public boolean expireIfLess(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLess in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfLessAsync

public RFuture<Boolean> expireIfLessAsync(Instant time)

Specified by:

expireIfLessAsync in interface RExpirableAsync

expireAsync

public RFuture<Boolean> expireAsync(Instant instant)

Description copied from interface: RExpirableAsync

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

instant - - expire date

Returns:

true if the timeout was set and false if not

expire

public boolean expire(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object. After the timeout has expired, the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(Duration duration)

Description copied from interface: RExpirableAsync

Set a timeout for object. After the timeout has expired, the key will automatically be deleted.

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(Date timestamp)

Description copied from interface: RExpirable

Use RExpirable.expire(Instant) instead

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(Date timestamp)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireIfSet

public boolean expireIfSet(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSet in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfSetAsync

public RFuture<Boolean> expireIfSetAsync(Duration duration)

Specified by:

expireIfSetAsync in interface RExpirableAsync

expireIfNotSet

public boolean expireIfNotSet(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSet in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfNotSetAsync

public RFuture<Boolean> expireIfNotSetAsync(Duration duration)

Specified by:

expireIfNotSetAsync in interface RExpirableAsync

expireIfGreater

public boolean expireIfGreater(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreater in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfGreaterAsync

public RFuture<Boolean> expireIfGreaterAsync(Duration duration)

Specified by:

expireIfGreaterAsync in interface RExpirableAsync

expireIfLess

public boolean expireIfLess(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLess in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfLessAsync

public RFuture<Boolean> expireIfLessAsync(Duration duration)

Specified by:

expireIfLessAsync in interface RExpirableAsync

clearExpire

public boolean clearExpire()

Description copied from interface: RExpirable

Clear an expire timeout or expire date for object.

Specified by:

clearExpire in interface RExpirable

Returns:

true if timeout was removed false if object does not exist or does not have an associated timeout

clearExpireAsync

public RFuture<Boolean> clearExpireAsync()

Description copied from interface: RExpirableAsync

Clear an expire timeout or expire date for object in async mode. Object will not be deleted.

Specified by:

clearExpireAsync in interface RExpirableAsync

Returns:

true if the timeout was cleared and false if not

remainTimeToLive

public long remainTimeToLive()

Description copied from interface: RExpirable

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLive in interface RExpirable

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

remainTimeToLiveAsync

public RFuture<Long> remainTimeToLiveAsync()

Description copied from interface: RExpirableAsync

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

getExpireTime

public long getExpireTime()

Description copied from interface: RExpirable

Expiration time of Redisson object that has a timeout

Requires Redis 7.0.0 and higher.

Specified by:

getExpireTime in interface RExpirable

Returns:

expiration time

getExpireTimeAsync

public RFuture<Long> getExpireTimeAsync()

Description copied from interface: RExpirableAsync

Expiration time of Redisson object that has a timeout

Requires Redis 7.0.0 and higher.

Specified by:

getExpireTimeAsync in interface RExpirableAsync

Returns:

expiration time

expireAsync

protected RFuture<Boolean> expireAsync(long timeToLive,
                                       TimeUnit timeUnit,
                                       String param,
                                       String... keys)

expireAtAsync

protected RFuture<Boolean> expireAtAsync(long timestamp,
                                         String param,
                                         String... keys)

clearExpireAsync

protected RFuture<Boolean> clearExpireAsync(String... keys)