RedissonTransactionalMap (Redisson/All-in-One 3.7.3 API)

java.lang.Object
- org.redisson.RedissonObject
- - org.redisson.RedissonMap<K,V>
  - - org.redisson.transaction.RedissonTransactionalMap<K,V>

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

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

Direct Known Subclasses:

RedissonTransactionalLocalCachedMap
```
public class RedissonTransactionalMap<K,V>
extends RedissonMap<K,V>
```
Author:

Nikita Koksharov

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class org.redisson.RedissonObject
  codec, commandExecutor

Constructor Summary

Constructors
Constructor and Description
`RedissonTransactionalMap(Codec codec, CommandAsyncExecutor commandExecutor, String name, List<TransactionalOperation> operations, long timeout, AtomicBoolean executed)`
`RedissonTransactionalMap(CommandAsyncExecutor commandExecutor, List<TransactionalOperation> operations, long timeout, AtomicBoolean executed, RMap<K,V> innerMap)`
`RedissonTransactionalMap(CommandAsyncExecutor commandExecutor, String name, List<TransactionalOperation> operations, long timeout, AtomicBoolean executed)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected RFuture<V>`	`addAndGetOperationAsync(K key, Number value)`
`protected void`	`checkState()`
`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)`
`RFuture<Boolean>`	`deleteAsync()` Delete object in async mode
`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.
`protected RFuture<Boolean>`	`fastPutIfAbsentOperationAsync(K key, V value)`
`protected RFuture<Boolean>`	`fastPutOperationAsync(K key, V value)`
`protected RFuture<Long>`	`fastRemoveOperationAsync(K... keys)`
`RFuture<Map<K,V>>`	`getAllOperationAsync(Set<K> keys)`
`RLock`	`getLock(K key)` Returns `RLock` instance associated with key
`RFuture<V>`	`getOperationAsync(K key)`
`RReadWriteLock`	`getReadWriteLock(K key)` Returns `RReadWriteLock` instance associated with key
`RFuture<Boolean>`	`isExistsAsync()` Check object existence in async mode.
`RFuture<Void>`	`loadAllAsync(boolean replaceExistingValues, int parallelism)` Loads all map entries to this Redis map using `MapLoader`.
`RFuture<Void>`	`loadAllAsync(Set<? extends K> keys, boolean replaceExistingValues, int parallelism)` Loads map entries using `MapLoader` whose keys are listed in defined `keys` parameter.
`<KOut,VOut> RMapReduce<K,V,KOut,VOut>`	`mapReduce()` Returns `RMapReduce` object associated with this map
`RFuture<Void>`	`migrateAsync(String host, int port, int database, long timeout)` Transfer object from source Redis instance to destination Redis instance in async mode
`RFuture<Boolean>`	`moveAsync(int database)` Move object to another database in async mode
`protected RFuture<Void>`	`putAllOperationAsync(Map<? extends K,? extends V> entries)`
`protected RFuture<V>`	`putIfAbsentOperationAsync(K key, V value)`
`protected RFuture<V>`	`putOperationAsync(K key, V value)`
`RFuture<Set<Map.Entry<K,V>>>`	`readAllEntrySetAsync()` Read all map entries at once
`RFuture<Set<K>>`	`readAllKeySetAsync()` Read all keys 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
`protected RFuture<V>`	`removeOperationAsync(K key)`
`protected RFuture<Boolean>`	`removeOperationAsync(Object key, Object value)`
`protected RFuture<V>`	`replaceOperationAsync(K key, V value)`
`protected RFuture<Boolean>`	`replaceOperationAsync(K key, V oldValue, V newValue)`
`MapScanResult<Object,Object>`	`scanIterator(String name, RedisClient client, long startPos, String pattern, int count)`
`RFuture<Boolean>`	`touchAsync()` Update the last access time of an object in async mode.
`RFuture<Boolean>`	`unlinkAsync()` Delete the objects.
`RFuture<Integer>`	`valueSizeAsync(K key)` Returns size of value mapped by key in bytes

Methods inherited from class org.redisson.RedissonMap
addAndGet, addAndGetAsync, checkKey, checkValue, clear, containsKey, containsValue, entryIterator, entrySet, entrySet, entrySet, entrySet, equals, fastPut, fastPutAsync, fastPutIfAbsent, fastPutIfAbsentAsync, fastRemove, fastRemoveAsync, fastRemoveOperationBatchAsync, fastReplace, fastReplaceAsync, fastReplaceOperationAsync, get, getAll, getAllAsync, getAsync, hashCode, hasNoLoader, hasNoWriter, isEmpty, keyIterator, keySet, keySet, keySet, keySet, loadAll, loadAll, mapWriterFuture, put, putAll, putAllAsync, putAsync, putIfAbsent, putIfAbsentAsync, readAllEntrySet, readAllKeySet, readAllMap, readAllValues, remove, remove, removeAsync, removeAsync, replace, replace, replaceAsync, replaceAsync, scanIteratorAsync, size, sizeAsync, valueIterator, values, values, values, values, valueSize

Methods inherited from class org.redisson.RedissonObject
await, copy, copyAsync, delete, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getName, getName, isExists, migrate, move, prefixName, rename, renameAsync, renamenx, renamenxAsync, suffixName, toSeconds, touch, unlink

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 org.redisson.api.RExpirable
clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject
copy, delete, getCodec, getName, isExists, migrate, move, rename, renamenx, touch, unlink

Methods inherited from interface org.redisson.api.RExpirableAsync
remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync
copyAsync, renameAsync, renamenxAsync

- Constructor Detail
  - RedissonTransactionalMap
```
public RedissonTransactionalMap(CommandAsyncExecutor commandExecutor,
                                List<TransactionalOperation> operations,
                                long timeout,
                                AtomicBoolean executed,
                                RMap<K,V> innerMap)
```
  - RedissonTransactionalMap
```
public RedissonTransactionalMap(CommandAsyncExecutor commandExecutor,
                                String name,
                                List<TransactionalOperation> operations,
                                long timeout,
                                AtomicBoolean executed)
```
  - RedissonTransactionalMap
```
public RedissonTransactionalMap(Codec codec,
                                CommandAsyncExecutor commandExecutor,
                                String name,
                                List<TransactionalOperation> operations,
                                long timeout,
                                AtomicBoolean executed)
```
- Method Detail
  - 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
  - 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
  - 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
  - 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
  - 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
    
    Overrides:
    
    moveAsync in class RedissonObject
    
    Parameters:
    
    database - - number of Redis database
    
    Returns:
    
    true if key was moved false if not
  - migrateAsync
```
public RFuture<Void> migrateAsync(String host,
                                  int port,
                                  int database,
                                  long timeout)
```
    Description copied from interface: RObjectAsync
    
    Transfer object from source Redis instance to destination Redis instance in async mode
    
    Specified by:
    
    migrateAsync in interface RObjectAsync
    
    Overrides:
    
    migrateAsync in class RedissonObject
    
    Parameters:
    
    host - - destination host
    
    port - - destination port
    
    database - - destination database
    
    timeout - - maximum idle time in any moment of the communication with the destination instance in milliseconds
    
    Returns:
    
    void
  - mapReduce
```
public <KOut,VOut> RMapReduce<K,V,KOut,VOut> mapReduce()
```
    Description copied from interface: RMap
    
    Returns RMapReduce object associated with this map
    
    Specified by:
    
    mapReduce in interface RMap<K,V>
    
    Overrides:
    
    mapReduce in class RedissonMap<K,V>
    
    Type Parameters:
    
    KOut - output key
    
    VOut - output value
    
    Returns:
    
    MapReduce instance
  - scanIterator
```
public MapScanResult<Object,Object> scanIterator(String name,
                                                 RedisClient client,
                                                 long startPos,
                                                 String pattern,
                                                 int count)
```
    Overrides:
    
    scanIterator in class RedissonMap<K,V>
  - 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>
  - addAndGetOperationAsync
```
protected RFuture<V> addAndGetOperationAsync(K key,
                                             Number value)
```
    Overrides:
    
    addAndGetOperationAsync in class RedissonMap<K,V>
  - putIfAbsentOperationAsync
```
protected RFuture<V> putIfAbsentOperationAsync(K key,
                                               V value)
```
    Overrides:
    
    putIfAbsentOperationAsync in class RedissonMap<K,V>
  - putOperationAsync
```
protected RFuture<V> putOperationAsync(K key,
                                       V value)
```
    Overrides:
    
    putOperationAsync in class RedissonMap<K,V>
  - fastPutIfAbsentOperationAsync
```
protected RFuture<Boolean> fastPutIfAbsentOperationAsync(K key,
                                                         V value)
```
    Overrides:
    
    fastPutIfAbsentOperationAsync in class RedissonMap<K,V>
  - fastPutOperationAsync
```
protected RFuture<Boolean> fastPutOperationAsync(K key,
                                                 V value)
```
    Overrides:
    
    fastPutOperationAsync in class RedissonMap<K,V>
  - fastRemoveOperationAsync
```
protected RFuture<Long> fastRemoveOperationAsync(K... keys)
```
    Overrides:
    
    fastRemoveOperationAsync in class RedissonMap<K,V>
  - valueSizeAsync
```
public RFuture<Integer> valueSizeAsync(K key)
```
    Description copied from interface: RMapAsync
    
    Returns size of value mapped by key in bytes
    
    Specified by:
    
    valueSizeAsync in interface RMapAsync<K,V>
    
    Overrides:
    
    valueSizeAsync in class RedissonMap<K,V>
    
    Parameters:
    
    key - - map key
    
    Returns:
    
    size of value
  - getOperationAsync
```
public RFuture<V> getOperationAsync(K key)
```
    Overrides:
    
    getOperationAsync in class RedissonMap<K,V>
  - readAllKeySetAsync
```
public RFuture<Set<K>> readAllKeySetAsync()
```
    Description copied from interface: RMapAsync
    
    Read all keys at once
    
    Specified by:
    
    readAllKeySetAsync in interface RMapAsync<K,V>
    
    Overrides:
    
    readAllKeySetAsync in class RedissonMap<K,V>
    
    Returns:
    
    keys
  - 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
  - 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
  - getAllOperationAsync
```
public RFuture<Map<K,V>> getAllOperationAsync(Set<K> keys)
```
    Overrides:
    
    getAllOperationAsync in class RedissonMap<K,V>
  - removeOperationAsync
```
protected RFuture<V> removeOperationAsync(K key)
```
    Overrides:
    
    removeOperationAsync in class RedissonMap<K,V>
  - removeOperationAsync
```
protected RFuture<Boolean> removeOperationAsync(Object key,
                                                Object value)
```
    Overrides:
    
    removeOperationAsync in class RedissonMap<K,V>
  - putAllOperationAsync
```
protected RFuture<Void> putAllOperationAsync(Map<? extends K,? extends V> entries)
```
    Overrides:
    
    putAllOperationAsync in class RedissonMap<K,V>
  - replaceOperationAsync
```
protected RFuture<Boolean> replaceOperationAsync(K key,
                                                 V oldValue,
                                                 V newValue)
```
    Overrides:
    
    replaceOperationAsync in class RedissonMap<K,V>
  - touchAsync
```
public RFuture<Boolean> touchAsync()
```
    Description copied from interface: RObjectAsync
    
    Update the last access time of an object in async mode.
    
    Specified by:
    
    touchAsync in interface RObjectAsync
    
    Overrides:
    
    touchAsync in class RedissonObject
    
    Returns:
    
    true if object was touched else false
  - isExistsAsync
```
public RFuture<Boolean> isExistsAsync()
```
    Description copied from interface: RObjectAsync
    
    Check object existence in async mode.
    
    Specified by:
    
    isExistsAsync in interface RObjectAsync
    
    Overrides:
    
    isExistsAsync in class RedissonObject
    
    Returns:
    
    true if object exists and false otherwise
  - unlinkAsync
```
public RFuture<Boolean> unlinkAsync()
```
    Description copied from interface: RObjectAsync
    
    Delete the objects. Actual removal will happen later asynchronously.
    Requires Redis 4.0+
    
    Specified by:
    
    unlinkAsync in interface RObjectAsync
    
    Overrides:
    
    unlinkAsync in class RedissonObject
    
    Returns:
    
    true if it was exist and deleted else false
  - 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
  - replaceOperationAsync
```
protected RFuture<V> replaceOperationAsync(K key,
                                           V value)
```
    Overrides:
    
    replaceOperationAsync in class RedissonMap<K,V>
  - checkState
```
protected void checkState()
```
  - loadAllAsync
```
public RFuture<Void> loadAllAsync(boolean replaceExistingValues,
                                  int parallelism)
```
    Description copied from interface: RMapAsync
    
    Loads all map entries to this Redis map using MapLoader.
    
    Specified by:
    
    loadAllAsync in interface RMapAsync<K,V>
    
    Overrides:
    
    loadAllAsync in class RedissonMap<K,V>
    
    Parameters:
    
    replaceExistingValues - - true if existed values should be replaced, false otherwise.
    
    parallelism - - parallelism level, used to increase speed of process execution
    
    Returns:
    
    void
  - loadAllAsync
```
public RFuture<Void> loadAllAsync(Set<? extends K> keys,
                                  boolean replaceExistingValues,
                                  int parallelism)
```
    Description copied from interface: RMapAsync
    
    Loads map entries using MapLoader whose keys are listed in defined keys parameter.
    
    Specified by:
    
    loadAllAsync in interface RMapAsync<K,V>
    
    Overrides:
    
    loadAllAsync in class RedissonMap<K,V>
    
    Parameters:
    
    keys - - map keys
    
    replaceExistingValues - - true if existed values should be replaced, false otherwise.
    
    parallelism - - parallelism level, used to increase speed of process execution
    
    Returns:
    
    void
  - getLock
```
public RLock getLock(K key)
```
    Description copied from interface: RMap
    
    Returns RLock instance associated with key
    
    Specified by:
    
    getLock in interface RMap<K,V>
    
    Overrides:
    
    getLock in class RedissonMap<K,V>
    
    Parameters:
    
    key - - map key
    
    Returns:
    
    lock
  - getReadWriteLock
```
public RReadWriteLock getReadWriteLock(K key)
```
    Description copied from interface: RMap
    
    Returns RReadWriteLock instance associated with key
    
    Specified by:
    
    getReadWriteLock in interface RMap<K,V>
    
    Overrides:
    
    getReadWriteLock in class RedissonMap<K,V>
    
    Parameters:
    
    key - - map key
    
    Returns:
    
    readWriteLock
  - 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
  - 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
  - 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
  - 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
  - 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.

Class RedissonTransactionalMap<K,V>

Nested Class Summary

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

Field Summary

Fields inherited from class org.redisson.RedissonObject

Constructor Summary

Method Summary

Methods inherited from class org.redisson.RedissonMap

Methods inherited from class org.redisson.RedissonObject

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.concurrent.ConcurrentMap

Methods inherited from interface org.redisson.api.RExpirable

Methods inherited from interface org.redisson.api.RObject

Methods inherited from interface org.redisson.api.RExpirableAsync

Methods inherited from interface org.redisson.api.RObjectAsync

Constructor Detail

RedissonTransactionalMap

RedissonTransactionalMap

RedissonTransactionalMap

Method Detail

expireAsync

expireAtAsync

expireAtAsync

clearExpireAsync

moveAsync

migrateAsync

mapReduce

scanIterator

containsKeyAsync

containsValueAsync

addAndGetOperationAsync

putIfAbsentOperationAsync

putOperationAsync

fastPutIfAbsentOperationAsync

fastPutOperationAsync

fastRemoveOperationAsync

valueSizeAsync

getOperationAsync

readAllKeySetAsync

readAllEntrySetAsync

readAllValuesAsync

readAllMapAsync

getAllOperationAsync

removeOperationAsync

removeOperationAsync

putAllOperationAsync

replaceOperationAsync

touchAsync

isExistsAsync

unlinkAsync

deleteAsync

replaceOperationAsync

checkState

loadAllAsync

loadAllAsync

getLock

getReadWriteLock

expire

expireAt

expireAt

clearExpire

remainTimeToLive

remainTimeToLiveAsync