Package org.redisson.api

Interface RMapCacheNative<K,V>

Type Parameters:

K - key

V - value

All Superinterfaces:

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

All Known Implementing Classes:

RedissonMapCacheNative

public interface RMapCacheNative<K,V>
extends RMap<K,V>, RMapCacheNativeAsync<K,V>

Map-based cache with ability to set TTL per entry. Uses Redis native commands for entry expiration and not a scheduled eviction task.

Requires Redis 7.4.0 and higher.

Author:

Nikita Koksharov

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

Modifier and Type	Method	Description
int	addListener(ObjectListener listener)	Adds object event listener
Map<K,Boolean>	clearExpire(Set<K> keys)	Clears an expiration timeout or date of specified entries by keys.
Boolean	clearExpire(K key)	Clears an expiration timeout or date of specified entry by key.
int	expireEntries(Set<K> keys, Duration ttl)	Updates time to live of specified entries by keys.
int	expireEntriesIfGreater(Set<K> keys, Duration ttl)	Sets time to live of specified entries by keys only if it's greater than timeout set before.
int	expireEntriesIfLess(Set<K> keys, Duration ttl)	Sets time to live of specified entries by keys only if it's less than timeout set before.
int	expireEntriesIfNotSet(Set<K> keys, Duration ttl)	Sets time to live of specified entries by keys.
boolean	expireEntry(K key, Duration ttl)	Updates time to live of specified entry by key.
boolean	expireEntryIfGreater(K key, Duration ttl)	Sets time to live of specified entry by key only if it's greater than timeout set before.
boolean	expireEntryIfLess(K key, Duration ttl)	Sets time to live of specified entry by key only if it's less than timeout set before.
boolean	expireEntryIfNotSet(K key, Duration ttl)	Sets time to live of specified entry by key.
boolean	fastPut(K key, V value, Duration ttl)	Stores value mapped by key with specified time to live.
boolean	fastPutIfAbsent(K key, V value, Duration ttl)	If the specified key is not already associated with a value, associate it with the given value.
V	put(K key, V value, Duration ttl)	Stores value mapped by key with specified time to live.
void	putAll(Map<? extends K,? extends V> map, Duration ttl)	Associates the specified value with the specified key in batch.
V	putIfAbsent(K key, V value, Duration ttl)	If the specified key is not already associated with a value, associate it with the given value.
Map<K,Long>	remainTimeToLive(Set<K> keys)	Remaining time to live of map entries associated with keys.
long	remainTimeToLive(K key)	Remaining time to live of map entry associated with a key.

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

destroy

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, clearAsync, computeAsync, computeIfAbsentAsync, computeIfPresentAsync, containsKeyAsync, containsValueAsync, fastPutAsync, fastPutIfAbsentAsync, fastPutIfExistsAsync, fastRemoveAsync, fastReplaceAsync, getAllAsync, getAsync, loadAllAsync, loadAllAsync, mergeAsync, putAllAsync, putAllAsync, putAsync, putIfAbsentAsync, putIfExistsAsync, randomEntriesAsync, randomKeysAsync, readAllEntrySetAsync, readAllKeySetAsync, readAllMapAsync, readAllValuesAsync, removeAsync, removeAsync, replaceAsync, replaceAsync, sizeAsync, valueSizeAsync

Methods inherited from interface org.redisson.api.RMapCacheNativeAsync

addListenerAsync, clearExpireAsync, clearExpireAsync, expireEntriesAsync, expireEntriesIfGreaterAsync, expireEntriesIfLessAsync, expireEntriesIfNotSetAsync, expireEntryAsync, expireEntryIfGreaterAsync, expireEntryIfLessAsync, expireEntryIfNotSetAsync, fastPutAsync, fastPutIfAbsentAsync, putAllAsync, putAsync, putIfAbsentAsync, remainTimeToLiveAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

copy, copy, copy, copyAndReplace, copyAndReplace, 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

copyAndReplaceAsync, copyAndReplaceAsync, copyAsync, copyAsync, copyAsync, deleteAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Method Details

put

V put(K key,
 V value,
 Duration ttl)

Stores value mapped by key with specified time to live. Entry expires after specified time to live.

If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

key - - map key

value - - map value

ttl - - time to live for key\value entry. If 0 then stores infinitely.

Returns:

previous associated value

fastPut

boolean fastPut(K key,
 V value,
 Duration ttl)

Stores value mapped by key with specified time to live. Entry expires after specified time to live.

If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Works faster than usual put(Object, Object, Duration) as it not returns previous value.

Parameters:

key - - map key

value - - map value

ttl - - time to live for key\value entry. If 0 then stores infinitely.

Returns:

true if key is a new key in the hash and value was set. false if key already exists in the hash and the value was updated.

putIfAbsent

V putIfAbsent(K key,
 V value,
 Duration ttl)

If the specified key is not already associated with a value, associate it with the given value.

Stores value mapped by key with specified time to live. Entry expires after specified time to live.

Parameters:

key - - map key

value - - map value

ttl - - time to live for key\value entry. If 0 then stores infinitely.

Returns:

current associated value

fastPutIfAbsent

boolean fastPutIfAbsent(K key,
 V value,
 Duration ttl)

If the specified key is not already associated with a value, associate it with the given value.

Stores value mapped by key with specified time to live. Entry expires after specified time to live.

Works faster than usual putIfAbsent(Object, Object, Duration) as it not returns previous value.

Parameters:

key - - map key

value - - map value

ttl - - time to live for key\value entry. If 0 then stores infinitely.

Returns:

true if key is a new key in the hash and value was set. false if key already exists in the hash

remainTimeToLive

long remainTimeToLive(K key)

Remaining time to live of map entry associated with a key.

Parameters:

key - map key

Returns:

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

remainTimeToLive

Map<K,Long> remainTimeToLive(Set<K> keys)

Remaining time to live of map entries associated with keys.

Parameters:

keys - map keys

Returns:

Time to live mapped by key. Time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

putAll

void putAll(Map<? extends K,? extends V> map,
 Duration ttl)

Associates the specified value with the specified key in batch.

If MapWriter is defined then new map entries will be stored in write-through mode.

Parameters:

map - - mappings to be stored in this map

ttl - - time to live for all key\value entries. If 0 then stores infinitely.

clearExpire

Boolean clearExpire(K key)

Clears an expiration timeout or date of specified entry by key.

Parameters:

key - map key

Returns:

true if timeout was removed false if entry does not have an associated timeout null if entry does not exist

clearExpire

Map<K,Boolean> clearExpire(Set<K> keys)

Clears an expiration timeout or date of specified entries by keys.

Parameters:

keys - map keys

Returns:

Boolean mapped by key. true if timeout was removed false if entry does not have an associated timeout null if entry does not exist

expireEntry

boolean expireEntry(K key,
 Duration ttl)

Updates time to live of specified entry by key. Entry expires when specified time to live was reached.

Returns false if entry already expired or doesn't exist, otherwise returns true.

Parameters:

key - map key

ttl - time to live for key\value entry. If 0 then time to live doesn't affect entry expiration.

if ttl params are equal to 0 then entry stores infinitely.

Returns:

returns false if entry already expired or doesn't exist, otherwise returns true.

expireEntryIfNotSet

boolean expireEntryIfNotSet(K key,
 Duration ttl)

Sets time to live of specified entry by key. If these parameters weren't set before. Entry expires when specified time to live was reached.

Returns false if entry already has expiration time or doesn't exist, otherwise returns true.

Parameters:

key - map key

ttl - time to live for key\value entry. If 0 then time to live doesn't affect entry expiration.

if ttl params are equal to 0 then entry stores infinitely.

Returns:

returns false if entry already has expiration time or doesn't exist, otherwise returns true.

expireEntryIfGreater

boolean expireEntryIfGreater(K key,
 Duration ttl)

Sets time to live of specified entry by key only if it's greater than timeout set before. Entry expires when specified time to live was reached.

Returns false if entry already has expiration time or doesn't exist, otherwise returns true.

Parameters:

key - map key

ttl - time to live for key\value entry. If 0 then time to live doesn't affect entry expiration.

if ttl params are equal to 0 then entry stores infinitely.

Returns:

returns false if entry already has expiration time or doesn't exist, otherwise returns true.

expireEntryIfLess

boolean expireEntryIfLess(K key,
 Duration ttl)

Sets time to live of specified entry by key only if it's less than timeout set before. Entry expires when specified time to live was reached.

Returns false if entry already has expiration time or doesn't exist, otherwise returns true.

Parameters:

key - map key

ttl - time to live for key\value entry. If 0 then time to live doesn't affect entry expiration.

if ttl params are equal to 0 then entry stores infinitely.

Returns:

returns false if entry already has expiration time or doesn't exist, otherwise returns true.

expireEntries

int expireEntries(Set<K> keys,
 Duration ttl)

Updates time to live of specified entries by keys. Entries expires when specified time to live was reached.

Returns amount of updated entries.

Parameters:

keys - map keys

ttl - time to live for key\value entries. If 0 then time to live doesn't affect entry expiration.

if ttl params are equal to 0 then entries are stored infinitely.

Returns:

amount of updated entries.

expireEntriesIfGreater

int expireEntriesIfGreater(Set<K> keys,
 Duration ttl)

Sets time to live of specified entries by keys only if it's greater than timeout set before. Entries expire when specified time to live was reached.

Returns amount of updated entries.

Parameters:

keys - map keys

ttl - time to live for key\value entry. If 0 then time to live doesn't affect entry expiration.

if ttl params are equal to 0 then entry stores infinitely.

Returns:

amount of updated entries.

expireEntriesIfLess

int expireEntriesIfLess(Set<K> keys,
 Duration ttl)

Sets time to live of specified entries by keys only if it's less than timeout set before. Entries expire when specified time to live was reached.

Returns amount of updated entries.

Parameters:

keys - map keys

ttl - time to live for key\value entry. If 0 then time to live doesn't affect entry expiration.

if ttl params are equal to 0 then entry stores infinitely.

Returns:

amount of updated entries.

expireEntriesIfNotSet

int expireEntriesIfNotSet(Set<K> keys,
 Duration ttl)

Sets time to live of specified entries by keys. If these parameters weren't set before. Entries expire when specified time to live was reached.

Returns amount of updated entries.

Parameters:

keys - map keys

ttl - time to live for key\value entry. If 0 then time to live doesn't affect entry expiration.

if ttl params are equal to 0 then entry stores infinitely.

Returns:

amount of updated entries.

addListener

int addListener(ObjectListener listener)

Adds object event listener

Specified by:

addListener in interface RMap<K,V>

Specified by:

addListener in interface RObject

Parameters:

listener - object event listener

Returns:

listener id

See Also:

• TrackingListener
• MapPutListener
• MapRemoveListener
• MapExpiredListener
• ExpiredObjectListener
• DeletedObjectListener