org.redisson

Class RedissonLocalCachedMap<K,V>

java.lang.Object

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>

Author:

Nikita Koksharov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RedissonLocalCachedMap.CacheKey
static class	RedissonLocalCachedMap.CacheValue
static class	RedissonLocalCachedMap.LocalCachedMapClear
static class	RedissonLocalCachedMap.LocalCachedMapInvalidate

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

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedissonLocalCachedMap(RedissonClient redisson, Codec codec, CommandAsyncExecutor connectionManager, String name, LocalCachedMapOptions options)
protected	RedissonLocalCachedMap(RedissonClient redisson, CommandAsyncExecutor commandExecutor, String name, LocalCachedMapOptions options)

Method Summary

Modifier and Type	Method and Description
RFuture<V>	addAndGetAsync(K key, Number value)
protected boolean	await(RFuture<?> future, long timeout, TimeUnit timeoutUnit)
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.
RFuture<Boolean>	containsKeyAsync(Object key)
RFuture<Boolean>	containsValueAsync(Object value)
boolean	delete() Deletes the object
RFuture<Boolean>	deleteAsync() Delete object in async mode
void	destroy() Allows to destroy object then it's not necessary anymore.
protected byte[]	encode(Object value)
protected byte[]	encodeMapKey(Object value)
protected byte[]	encodeMapValue(Object value)
Set<Map.Entry<K,V>>	entrySet() Returns values collections.
boolean	expire(long timeToLive, TimeUnit timeUnit) Set a timeout for object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit) Set a timeout for object in async mode.
boolean	expireAt(Date timestamp) Set an expire date for object.
boolean	expireAt(long timestamp) Set an expire date for object.
RFuture<Boolean>	expireAtAsync(Date timestamp) Set an expire date for object in async mode.
RFuture<Boolean>	expireAtAsync(long timestamp) Set an expire date for object in async mode.
RFuture<Boolean>	fastPutAsync(K key, V value) Associates the specified value with the specified key in async manner.
RFuture<Boolean>	fastPutIfAbsentAsync(K key, V value)
RFuture<Long>	fastRemoveAsync(K... keys) Removes keys from map by one operation in async manner Works faster than RMap.removeAsync but doesn't return the value associated with key
protected byte[]	generateId()
protected <V> V	get(RFuture<V> future)
RFuture<Map<K,V>>	getAllAsync(Set<K> keys)
RFuture<V>	getAsync(Object key)
Codec	getCodec() Returns the underlying Codec used by this RObject
String	getName() Returns name of object
boolean	isExists() Check object existence
RFuture<Boolean>	isExistsAsync() Check object existence in async mode.
Set<K>	keySet() Returns key set.
void	migrate(String host, int port, int database) Transfer an object from source Redis instance to destination Redis instance
RFuture<Void>	migrateAsync(String host, int port, int database) Transfer an object from source Redis instance to destination Redis instance in async mode
boolean	move(int database) Move object to another database
RFuture<Boolean>	moveAsync(int database) Move object to another database in async mode
protected <V> RPromise<V>	newPromise()
protected <V> RFuture<V>	newSucceededFuture(V result)
void	putAll(Map<? extends K,? extends V> m)
RFuture<Void>	putAllAsync(Map<? extends K,? extends V> map)
RFuture<V>	putAsync(K key, V value)
RFuture<V>	putIfAbsentAsync(K key, V value)
RFuture<Set<Map.Entry<K,V>>>	readAllEntrySetAsync() Read all map entries 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() Get remaining time to live of object in seconds.
RFuture<V>	removeAsync(K key)
RFuture<Boolean>	removeAsync(Object key, Object value)
void	rename(String newName) Rename current object key to newName
RFuture<Void>	renameAsync(String newName) Rename current object key to newName in async mode
boolean	renamenx(String newName) Rename current object key to newName only if new key is not exists
RFuture<Boolean>	renamenxAsync(String newName) Rename current object key to newName in async mode only if new key is not exists
RFuture<V>	replaceAsync(K key, V value)
RFuture<Boolean>	replaceAsync(K key, V oldValue, V newValue)
Collection<V>	values() Returns values collections.

Methods inherited from class org.redisson.RedissonMap

addAndGet, clear, containsKey, containsValue, entryIterator, equals, fastPut, fastPutIfAbsent, fastRemove, get, getAll, getName, hashCode, isEmpty, keyIterator, put, putIfAbsent, readAllEntrySet, readAllKeySet, readAllKeySetAsync, readAllValues, remove, remove, replace, replace, size, sizeAsync, valueIterator, valueSize, valueSizeAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.api.RMap

addAndGet, fastPut, fastPutIfAbsent, fastRemove, getAll, readAllEntrySet, readAllKeySet, readAllValues, valueSize

Methods inherited from interface java.util.concurrent.ConcurrentMap

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, remove, size

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

delete, getCodec, getName, isExists, migrate, move, rename, renamenx

Methods inherited from interface org.redisson.api.RMapAsync

readAllKeySetAsync, sizeAsync, valueSizeAsync

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync

Constructor Detail

RedissonLocalCachedMap

protected RedissonLocalCachedMap(RedissonClient redisson,
                                 CommandAsyncExecutor commandExecutor,
                                 String name,
                                 LocalCachedMapOptions options)

RedissonLocalCachedMap

protected RedissonLocalCachedMap(RedissonClient redisson,
                                 Codec codec,
                                 CommandAsyncExecutor connectionManager,
                                 String name,
                                 LocalCachedMapOptions options)

Method Detail

containsKeyAsync

public RFuture<Boolean> containsKeyAsync(Object key)

Specified by:

containsKeyAsync in interface RMapAsync<K,V>

Overrides:

containsKeyAsync in class RedissonMap<K,V>

containsValueAsync

public RFuture<Boolean> containsValueAsync(Object value)

Specified by:

containsValueAsync in interface RMapAsync<K,V>

Overrides:

containsValueAsync in class RedissonMap<K,V>

getAsync

public RFuture<V> getAsync(Object key)

Specified by:

getAsync in interface RMapAsync<K,V>

Overrides:

getAsync in class RedissonMap<K,V>

generateId

protected byte[] generateId()

putAsync

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

Specified by:

putAsync in interface RMapAsync<K,V>

Overrides:

putAsync in class RedissonMap<K,V>

fastPutAsync

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

Description copied from interface: RMapAsync

Associates the specified value with the specified key in async manner. Works faster than RMap.putAsync but not returning the previous value associated with key

Specified by:

fastPutAsync in interface RMapAsync<K,V>

Overrides:

fastPutAsync in class RedissonMap<K,V>

Parameters:

key - - map key

value - - map value

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.

destroy

public void destroy()

Description copied from interface: RDestroyable

Allows to destroy object then it's not necessary anymore.

Specified by:

destroy in interface RDestroyable

removeAsync

public RFuture<V> removeAsync(K key)

Specified by:

removeAsync in interface RMapAsync<K,V>

Overrides:

removeAsync in class RedissonMap<K,V>

fastRemoveAsync

public RFuture<Long> fastRemoveAsync(K... keys)

Description copied from interface: RMapAsync

Removes keys from map by one operation in async manner Works faster than RMap.removeAsync but doesn't return the value associated with key

Specified by:

fastRemoveAsync in interface RMapAsync<K,V>

Overrides:

fastRemoveAsync in class RedissonMap<K,V>

Parameters:

keys - - map keys

Returns:

the number of keys that were removed from the hash, not including specified but non existing keys

putAll

public void putAll(Map<? extends K,? extends V> m)

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class RedissonMap<K,V>

deleteAsync

public RFuture<Boolean> deleteAsync()

Description copied from interface: RObjectAsync

Delete object in async mode

Specified by:

deleteAsync in interface RObjectAsync

Returns:

true if object was deleted false if not

keySet

public Set<K> keySet()

Description copied from interface: RMap

Returns key set. This method DOESN'T fetch all of them as RMap.readAllKeySet() does.

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface RMap<K,V>

Overrides:

keySet in class RedissonMap<K,V>

values

public Collection<V> values()

Description copied from interface: RMap

Returns values collections. This method DOESN'T fetch all of them as RMap.readAllValues() does.

Specified by:

values in interface Map<K,V>

Specified by:

values in interface RMap<K,V>

Overrides:

values in class RedissonMap<K,V>

entrySet

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

Description copied from interface: RMap

Returns values collections. This method DOESN'T fetch all of them as RMap.readAllEntrySet() does.

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in interface RMap<K,V>

Overrides:

entrySet in class RedissonMap<K,V>

getAllAsync

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

Specified by:

getAllAsync in interface RMapAsync<K,V>

Overrides:

getAllAsync in class RedissonMap<K,V>

putAllAsync

public RFuture<Void> putAllAsync(Map<? extends K,? extends V> map)

Specified by:

putAllAsync in interface RMapAsync<K,V>

Overrides:

putAllAsync in class RedissonMap<K,V>

addAndGetAsync

public RFuture<V> addAndGetAsync(K key,
                                 Number value)

Specified by:

addAndGetAsync in interface RMapAsync<K,V>

Overrides:

addAndGetAsync in class RedissonMap<K,V>

fastPutIfAbsentAsync

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

Specified by:

fastPutIfAbsentAsync in interface RMapAsync<K,V>

Overrides:

fastPutIfAbsentAsync in class RedissonMap<K,V>

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

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

replaceAsync

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

Specified by:

replaceAsync in interface RMapAsync<K,V>

Overrides:

replaceAsync in class RedissonMap<K,V>

replaceAsync

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

Specified by:

replaceAsync in interface RMapAsync<K,V>

Overrides:

replaceAsync in class RedissonMap<K,V>

removeAsync

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

Specified by:

removeAsync in interface RMapAsync<K,V>

Overrides:

removeAsync in class RedissonMap<K,V>

putIfAbsentAsync

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

Specified by:

putIfAbsentAsync in interface RMapAsync<K,V>

Overrides:

putIfAbsentAsync in class RedissonMap<K,V>

expire

public boolean expire(long timeToLive,
                      TimeUnit timeUnit)

Description copied from interface: RExpirable

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

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

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

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

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

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

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

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date in seconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(Date timestamp)

Description copied from interface: RExpirable

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

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

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

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

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

Get remaining time to live of object in seconds.

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

-1 if object does not exist or time in seconds

await

protected boolean await(RFuture<?> future,
                        long timeout,
                        TimeUnit timeoutUnit)
                 throws InterruptedException

Throws:

InterruptedException

get

protected <V> V get(RFuture<V> future)

newPromise

protected <V> RPromise<V> newPromise()

newSucceededFuture

protected <V> RFuture<V> newSucceededFuture(V result)

getName

public String getName()

Description copied from interface: RObject

Returns name of object

Specified by:

getName in interface RObject

Returns:

name - name of object

rename

public void rename(String newName)

Description copied from interface: RObject

Rename current object key to newName

Specified by:

rename in interface RObject

Parameters:

newName - - new name of object

renameAsync

public RFuture<Void> renameAsync(String newName)

Description copied from interface: RObjectAsync

Rename current object key to newName in async mode

Specified by:

renameAsync in interface RObjectAsync

Parameters:

newName - - new name of object

Returns:

void

migrate

public void migrate(String host,
                    int port,
                    int database)

Description copied from interface: RObject

Transfer an object from source Redis instance to destination Redis instance

Specified by:

migrate in interface RObject

Parameters:

host - - destination host

port - - destination port

database - - destination database

migrateAsync

public RFuture<Void> migrateAsync(String host,
                                  int port,
                                  int database)

Description copied from interface: RObjectAsync

Transfer an object from source Redis instance to destination Redis instance in async mode

Specified by:

migrateAsync in interface RObjectAsync

Parameters:

host - - destination host

port - - destination port

database - - destination database

Returns:

void

move

public boolean move(int database)

Description copied from interface: RObject

Move object to another database

Specified by:

move in interface RObject

Parameters:

database - - Redis database number

Returns:

true if key was moved else false

moveAsync

public RFuture<Boolean> moveAsync(int database)

Description copied from interface: RObjectAsync

Move object to another database in async mode

Specified by:

moveAsync in interface RObjectAsync

Parameters:

database - - number of Redis database

Returns:

true if key was moved false if not

renamenx

public boolean renamenx(String newName)

Description copied from interface: RObject

Rename current object key to newName only if new key is not exists

Specified by:

renamenx in interface RObject

Parameters:

newName - - new name of object

Returns:

true if object has been renamed successfully and false otherwise

renamenxAsync

public RFuture<Boolean> renamenxAsync(String newName)

Description copied from interface: RObjectAsync

Rename current object key to newName in async mode only if new key is not exists

Specified by:

renamenxAsync in interface RObjectAsync

Parameters:

newName - - new name of object

Returns:

true if object has been renamed successfully and false otherwise

delete

public boolean delete()

Description copied from interface: RObject

Deletes the object

Specified by:

delete in interface RObject

Returns:

true if it was exist and deleted else false

isExists

public boolean isExists()

Description copied from interface: RObject

Check object existence

Specified by:

isExists in interface RObject

Returns:

true if object exists and false otherwise

isExistsAsync

public RFuture<Boolean> isExistsAsync()

Description copied from interface: RObjectAsync

Check object existence in async mode.

Specified by:

isExistsAsync in interface RObjectAsync

Returns:

true if object exists and false otherwise

getCodec

public Codec getCodec()

Description copied from interface: RObject

Returns the underlying Codec used by this RObject

Specified by:

getCodec in interface RObject

Returns:

Codec of object

encode

protected byte[] encode(Object value)

encodeMapKey

protected byte[] encodeMapKey(Object value)

encodeMapValue

protected byte[] encodeMapValue(Object value)