org.redisson.api

Interface RMap<K,V>

Type Parameters:

K - map key

V - value

All Superinterfaces:

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

All Known Subinterfaces:

RLocalCachedMap<K,V>, RMapCache<K,V>

All Known Implementing Classes:

RedissonLocalCachedMap, RedissonMap, RedissonMapCache

public interface RMap<K,V>
extends ConcurrentMap<K,V>, RExpirable, RMapAsync<K,V>

Distributed and concurrent implementation of ConcurrentMap and Map This map doesn't allow to store null as key or value.

Author:

Nikita Koksharov

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
V	addAndGet(K key, Number delta) Atomically adds the given delta to the current value by mapped key.
Set<Map.Entry<K,V>>	entrySet() Returns values collections.
boolean	fastPut(K key, V value) Associates the specified value with the specified key.
boolean	fastPutIfAbsent(K key, V value)
long	fastRemove(K... keys) Removes keys from map by one operation Works faster than RMap.remove but not returning the value associated with key
Map<K,V>	getAll(Set<K> keys) Gets a map slice contains the mappings with defined keys by one operation.
RLock	getLock(K key) Returns RLock instance associated with key
RReadWriteLock	getReadWriteLock(K key) Returns RReadWriteLock instance associated with key
Set<K>	keySet() Returns key set.
Set<Map.Entry<K,V>>	readAllEntrySet() Read all map entries at once
Set<K>	readAllKeySet() Read all keys at once
Collection<V>	readAllValues() Read all values at once
Collection<V>	values() Returns values collections.
int	valueSize(K key) Returns size of value mapped by key in bytes

Methods inherited from interface java.util.concurrent.ConcurrentMap

putIfAbsent, remove, replace, replace

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, putAll, 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, touch

Methods inherited from interface org.redisson.api.RMapAsync

addAndGetAsync, containsKeyAsync, containsValueAsync, fastPutAsync, fastPutIfAbsentAsync, fastRemoveAsync, getAllAsync, getAsync, putAllAsync, putAsync, putIfAbsentAsync, readAllEntrySetAsync, readAllKeySetAsync, readAllValuesAsync, removeAsync, removeAsync, replaceAsync, replaceAsync, sizeAsync, valueSizeAsync

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

deleteAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, touchAsync

Method Detail

getReadWriteLock

RReadWriteLock getReadWriteLock(K key)

Returns RReadWriteLock instance associated with key

Parameters:

key - - map key

Returns:

readWriteLock

getLock

RLock getLock(K key)

Returns RLock instance associated with key

Parameters:

key - - map key

Returns:

lock

valueSize

int valueSize(K key)

Returns size of value mapped by key in bytes

Parameters:

key - - map key

Returns:

size of value

addAndGet

V addAndGet(K key,
          Number delta)

Atomically adds the given delta to the current value by mapped key. Works only for numeric values!

Parameters:

key - - map key

delta - the value to add

Returns:

the updated value

getAll

Map<K,V> getAll(Set<K> keys)

Gets a map slice contains the mappings with defined keys by one operation. This operation NOT traverses all map entries like any other filter* method, so works faster. The returned map is NOT backed by the original map.

Parameters:

keys - - map keys

Returns:

Map object

fastRemove

long fastRemove(K... keys)

Removes keys from map by one operation Works faster than RMap.remove but not returning the value associated with key

Parameters:

keys - - map keys

Returns:

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

fastPut

boolean fastPut(K key,
              V value)

Associates the specified value with the specified key. Works faster than RMap.put but not returning the previous value associated with key

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.

fastPutIfAbsent

boolean fastPutIfAbsent(K key,
                      V value)

readAllKeySet

Set<K> readAllKeySet()

Read all keys at once

Returns:

keys

readAllValues

Collection<V> readAllValues()

Read all values at once

Returns:

values

readAllEntrySet

Set<Map.Entry<K,V>> readAllEntrySet()

Read all map entries at once

Returns:

entries

keySet

Set<K> keySet()

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

Specified by:

keySet in interface Map<K,V>

values

Collection<V> values()

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

Specified by:

values in interface Map<K,V>

entrySet

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

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

Specified by:

entrySet in interface Map<K,V>