RedissonBatch (Redisson 2.9.2 API)

java.lang.Object
- org.redisson.RedissonBatch

All Implemented Interfaces:: RBatch

public class RedissonBatch
extends Object
implements RBatch

Author:: Nikita Koksharov

Constructor Summary

Constructors
Modifier Constructor and Description

protected RedissonBatch(UUID id, EvictionScheduler evictionScheduler, ConnectionManager connectionManager)

Constructors
Modifier	Constructor and Description
`protected`	`RedissonBatch(UUID id, EvictionScheduler evictionScheduler, ConnectionManager connectionManager)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`enableRedissonReferenceSupport(Redisson redisson)`
`List<?>`	`execute()` Executes all operations accumulated during async methods invocations.
`RFuture<List<?>>`	`executeAsync()` Executes all operations accumulated during async methods invocations asynchronously.
`void`	`executeSkipResult()` Executes all operations accumulated during async methods invocations.
`RFuture<Void>`	`executeSkipResultAsync()` Executes all operations accumulated during async methods invocations asynchronously, Command replies are skipped such approach saves response bandwidth.
`RAtomicDoubleAsync`	`getAtomicDouble(String name)` Returns atomicDouble instance by name.
`RAtomicLongAsync`	`getAtomicLong(String name)` Returns atomicLong instance by name.
`RBitSetAsync`	`getBitSet(String name)`
`<V> RBlockingDequeAsync<V>`	`getBlockingDeque(String name)` Returns blocking deque instance by name.
`<V> RBlockingDequeAsync<V>`	`getBlockingDeque(String name, Codec codec)`
`<V> RBlockingQueueAsync<V>`	`getBlockingQueue(String name)` Returns blocking queue instance by name.
`<V> RBlockingQueueAsync<V>`	`getBlockingQueue(String name, Codec codec)`
`<V> RBucketAsync<V>`	`getBucket(String name)` Returns object holder by `name`
`<V> RBucketAsync<V>`	`getBucket(String name, Codec codec)`
`<V> RDequeAsync<V>`	`getDeque(String name)` Returns deque instance by name.
`<V> RDequeAsync<V>`	`getDeque(String name, Codec codec)`
`<V> RGeoAsync<V>`	`getGeo(String name)` Returns geospatial items holder instance by `name`.
`<V> RGeoAsync<V>`	`getGeo(String name, Codec codec)` Returns geospatial items holder instance by `name` using provided codec for geospatial members.
`<V> RHyperLogLogAsync<V>`	`getHyperLogLog(String name)` Returns HyperLogLog object
`<V> RHyperLogLogAsync<V>`	`getHyperLogLog(String name, Codec codec)`
`RKeysAsync`	`getKeys()` Returns keys operations.
`RLexSortedSetAsync`	`getLexSortedSet(String name)` Returns String based Redis Sorted Set instance by name All elements are inserted with the same score during addition, in order to force lexicographical ordering
`<V> RListAsync<V>`	`getList(String name)` Returns list instance by name.
`<V> RListAsync<V>`	`getList(String name, Codec codec)`
`<K,V> RMultimapAsync<K,V>`	`getListMultimap(String name)` Returns List based MultiMap instance by name.
`<K,V> RMultimapAsync<K,V>`	`getListMultimap(String name, Codec codec)` Returns List based MultiMap instance by name using provided codec for both map keys and values.
`<K,V> RMultimapCacheAsync<K,V>`	`getListMultimapCache(String name)` Returns List based Multimap instance by name.
`<K,V> RMultimapCacheAsync<K,V>`	`getListMultimapCache(String name, Codec codec)` Returns List based Multimap instance by name using provided codec for both map keys and values.
`<K,V> RMapAsync<K,V>`	`getMap(String name)` Returns map instance by name.
`<K,V> RMapAsync<K,V>`	`getMap(String name, Codec codec)`
`<K,V> RMapCacheAsync<K,V>`	`getMapCache(String name)` Returns map-based cache instance by `name`.
`<K,V> RMapCacheAsync<K,V>`	`getMapCache(String name, Codec codec)` Returns map-based cache instance by `name` using provided `codec` for both cache keys and values.
`<V> RQueueAsync<V>`	`getQueue(String name)` Returns queue instance by name.
`<V> RQueueAsync<V>`	`getQueue(String name, Codec codec)`
`<V> RScoredSortedSetAsync<V>`	`getScoredSortedSet(String name)` Returns Redis Sorted Set instance by name
`<V> RScoredSortedSetAsync<V>`	`getScoredSortedSet(String name, Codec codec)`
`RScriptAsync`	`getScript()` Returns script operations object
`<V> RSetAsync<V>`	`getSet(String name)` Returns set instance by name.
`<V> RSetAsync<V>`	`getSet(String name, Codec codec)`
`<V> RSetCacheAsync<V>`	`getSetCache(String name)` Returns set-based cache instance by `name`.
`<V> RSetCacheAsync<V>`	`getSetCache(String name, Codec codec)` Returns set-based cache instance by `name` using provided `codec` for values.
`<K,V> RMultimapAsync<K,V>`	`getSetMultimap(String name)` Returns Set based MultiMap instance by name.
`<K,V> RMultimapAsync<K,V>`	`getSetMultimap(String name, Codec codec)` Returns Set based MultiMap instance by name using provided codec for both map keys and values.
`<K,V> RMultimapCacheAsync<K,V>`	`getSetMultimapCache(String name)` Returns Set based Multimap instance by name.
`<K,V> RMultimapCacheAsync<K,V>`	`getSetMultimapCache(String name, Codec codec)` Returns Set based Multimap instance by name using provided codec for both map keys and values.
`<M> RTopicAsync<M>`	`getTopic(String name)` Returns topic instance by name.
`<M> RTopicAsync<M>`	`getTopic(String name, Codec codec)`
`RBatch`	`retryAttempts(int retryAttempts)` Defines attempts amount to re-send Redis commands batch if it hasn't been sent already.
`RBatch`	`retryInterval(long retryInterval, TimeUnit unit)` Defines time interval for another one attempt send Redis commands batch if it hasn't been sent already.
`RBatch`	`timeout(long timeout, TimeUnit unit)` Defines timeout for Redis response.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RedissonBatch
```
protected RedissonBatch(UUID id,
             EvictionScheduler evictionScheduler,
             ConnectionManager connectionManager)
```
- Method Detail
  - getBucket
```
public <V> RBucketAsync<V> getBucket(String name)
```
    Description copied from interface: RBatch
    
    Returns object holder by name
    
    Specified by:
    
    getBucket in interface RBatch
    
    Type Parameters:
    V - type of object
    Parameters:
    name - - name of object
    
    Returns:
    Bucket object
  - getBucket
```
public <V> RBucketAsync<V> getBucket(String name,
                            Codec codec)
```
    Specified by:
    
    getBucket in interface RBatch
  - getHyperLogLog
```
public <V> RHyperLogLogAsync<V> getHyperLogLog(String name)
```
    Description copied from interface: RBatch
    
    Returns HyperLogLog object
    
    Specified by:
    
    getHyperLogLog in interface RBatch
    
    Type Parameters:
    V - type of object
    Parameters:
    name - - name of object
    
    Returns:
    HyperLogLog object
  - getHyperLogLog
```
public <V> RHyperLogLogAsync<V> getHyperLogLog(String name,
                                      Codec codec)
```
    Specified by:
    
    getHyperLogLog in interface RBatch
  - getList
```
public <V> RListAsync<V> getList(String name)
```
    Description copied from interface: RBatch
    
    Returns list instance by name.
    
    Specified by:
    
    getList in interface RBatch
    
    Type Parameters:
    V - type of object
    Parameters:
    name - - name of object
    
    Returns:
    List object
  - getList
```
public <V> RListAsync<V> getList(String name,
                        Codec codec)
```
    Specified by:
    
    getList in interface RBatch
  - getMap
```
public <K,V> RMapAsync<K,V> getMap(String name)
```
    Description copied from interface: RBatch
    
    Returns map instance by name.
    
    Specified by:
    
    getMap in interface RBatch
    
    Type Parameters:
    K - type of key
    V - type of value
    Parameters:
    name - - name of object
    
    Returns:
    Map object
  - getMap
```
public <K,V> RMapAsync<K,V> getMap(String name,
                          Codec codec)
```
    Specified by:
    
    getMap in interface RBatch
  - getSet
```
public <V> RSetAsync<V> getSet(String name)
```
    Description copied from interface: RBatch
    
    Returns set instance by name.
    
    Specified by:
    
    getSet in interface RBatch
    
    Type Parameters:
    V - type of value
    Parameters:
    name - - name of object
    
    Returns:
    Set object
  - getSet
```
public <V> RSetAsync<V> getSet(String name,
                      Codec codec)
```
    Specified by:
    
    getSet in interface RBatch
  - getTopic
```
public <M> RTopicAsync<M> getTopic(String name)
```
    Description copied from interface: RBatch
    
    Returns topic instance by name.
    
    Specified by:
    
    getTopic in interface RBatch
    
    Type Parameters:
    M - type of message
    Parameters:
    name - - name of object
    
    Returns:
    Topic object
  - getTopic
```
public <M> RTopicAsync<M> getTopic(String name,
                          Codec codec)
```
    Specified by:
    
    getTopic in interface RBatch
  - getQueue
```
public <V> RQueueAsync<V> getQueue(String name)
```
    Description copied from interface: RBatch
    
    Returns queue instance by name.
    
    Specified by:
    
    getQueue in interface RBatch
    
    Type Parameters:
    V - type of value
    Parameters:
    name - - name of object
    
    Returns:
    Queue object
  - getQueue
```
public <V> RQueueAsync<V> getQueue(String name,
                          Codec codec)
```
    Specified by:
    
    getQueue in interface RBatch
  - getBlockingQueue
```
public <V> RBlockingQueueAsync<V> getBlockingQueue(String name)
```
    Description copied from interface: RBatch
    
    Returns blocking queue instance by name.
    
    Specified by:
    
    getBlockingQueue in interface RBatch
    
    Type Parameters:
    V - type of value
    Parameters:
    name - - name of object
    
    Returns:
    BlockingQueue object
  - getBlockingQueue
```
public <V> RBlockingQueueAsync<V> getBlockingQueue(String name,
                                          Codec codec)
```
    Specified by:
    
    getBlockingQueue in interface RBatch
  - getBlockingDeque
```
public <V> RBlockingDequeAsync<V> getBlockingDeque(String name)
```
    Description copied from interface: RBatch
    
    Returns blocking deque instance by name.
    
    Specified by:
    
    getBlockingDeque in interface RBatch
    
    Type Parameters:
    V - type of value
    Parameters:
    name - - name of object
    
    Returns:
    BlockingDeque object
  - getBlockingDeque
```
public <V> RBlockingDequeAsync<V> getBlockingDeque(String name,
                                          Codec codec)
```
    Specified by:
    
    getBlockingDeque in interface RBatch
  - getDeque
```
public <V> RDequeAsync<V> getDeque(String name)
```
    Description copied from interface: RBatch
    
    Returns deque instance by name.
    
    Specified by:
    
    getDeque in interface RBatch
    
    Type Parameters:
    V - type of value
    Parameters:
    name - - name of object
    
    Returns:
    Deque object
  - getDeque
```
public <V> RDequeAsync<V> getDeque(String name,
                          Codec codec)
```
    Specified by:
    
    getDeque in interface RBatch
  - getAtomicLong
```
public RAtomicLongAsync getAtomicLong(String name)
```
    Description copied from interface: RBatch
    
    Returns atomicLong instance by name.
    
    Specified by:
    
    getAtomicLong in interface RBatch
    
    Parameters:
    name - - name of object
    
    Returns:
    AtomicLong object
  - getAtomicDouble
```
public RAtomicDoubleAsync getAtomicDouble(String name)
```
    Description copied from interface: RBatch
    
    Returns atomicDouble instance by name.
    
    Specified by:
    
    getAtomicDouble in interface RBatch
    
    Parameters:
    name - - name of object
    
    Returns:
    AtomicDouble object
  - getScoredSortedSet
```
public <V> RScoredSortedSetAsync<V> getScoredSortedSet(String name)
```
    Description copied from interface: RBatch
    
    Returns Redis Sorted Set instance by name
    
    Specified by:
    
    getScoredSortedSet in interface RBatch
    
    Type Parameters:
    V - type of value
    Parameters:
    name - - name of object
    
    Returns:
    ScoredSortedSet object
  - getScoredSortedSet
```
public <V> RScoredSortedSetAsync<V> getScoredSortedSet(String name,
                                              Codec codec)
```
    Specified by:
    
    getScoredSortedSet in interface RBatch
  - getLexSortedSet
```
public RLexSortedSetAsync getLexSortedSet(String name)
```
    Description copied from interface: RBatch
    
    Returns String based Redis Sorted Set instance by name All elements are inserted with the same score during addition, in order to force lexicographical ordering
    
    Specified by:
    
    getLexSortedSet in interface RBatch
    
    Parameters:
    name - - name of object
    
    Returns:
    LexSortedSet object
  - getBitSet
```
public RBitSetAsync getBitSet(String name)
```
    Specified by:
    
    getBitSet in interface RBatch
  - getMapCache
```
public <K,V> RMapCacheAsync<K,V> getMapCache(String name,
                                    Codec codec)
```
    Description copied from interface: RBatch
    
    Returns map-based cache instance by name using provided codec for both cache keys and values. Supports entry eviction with a given TTL value.
    If eviction is not required then it's better to use regular map RBatch.getMap(String, Codec).
    
    Specified by:
    
    getMapCache in interface RBatch
    
    Type Parameters:
    K - type of key
    V - type of value
    Parameters:
    name - - name of object
    codec - - codec for keys and values
    
    Returns:
    MapCache object
  - getMapCache
```
public <K,V> RMapCacheAsync<K,V> getMapCache(String name)
```
    Description copied from interface: RBatch
    
    Returns map-based cache instance by name. Supports entry eviction with a given TTL value.
    If eviction is not required then it's better to use regular map RBatch.getMap(String).
    
    Specified by:
    
    getMapCache in interface RBatch
    
    Type Parameters:
    K - type of key
    V - type of value
    Parameters:
    name - - name of object
    
    Returns:
    MapCache object
  - getScript
```
public RScriptAsync getScript()
```
    Description copied from interface: RBatch
    
    Returns script operations object
    
    Specified by:
    
    getScript in interface RBatch
    
    Returns:
    Script object
  - getKeys
```
public RKeysAsync getKeys()
```
    Description copied from interface: RBatch
    
    Returns keys operations. Each of Redis/Redisson object associated with own key
    
    Specified by:
    
    getKeys in interface RBatch
    
    Returns:
    Keys object
  - getSetCache
```
public <V> RSetCacheAsync<V> getSetCache(String name)
```
    Description copied from interface: RBatch
    
    Returns set-based cache instance by name. Uses map (value_hash, value) under the hood for minimal memory consumption. Supports value eviction with a given TTL value.
    If eviction is not required then it's better to use regular map RBatch.getSet(String, Codec).
    
    Specified by:
    
    getSetCache in interface RBatch
    
    Type Parameters:
    V - type of value
    Parameters:
    name - - name of object
    
    Returns:
    SetCache object
  - getSetCache
```
public <V> RSetCacheAsync<V> getSetCache(String name,
                                Codec codec)
```
    Description copied from interface: RBatch
    
    Returns set-based cache instance by name using provided codec for values. Uses map (value_hash, value) under the hood for minimal memory consumption. Supports value eviction with a given TTL value.
    If eviction is not required then it's better to use regular map RBatch.getSet(String, Codec).
    
    Specified by:
    
    getSetCache in interface RBatch
    
    Type Parameters:
    V - type of value
    Parameters:
    name - - name of object
    codec - - codec for values
    
    Returns:
    SetCache object
  - retryAttempts
```
public RBatch retryAttempts(int retryAttempts)
```
    Description copied from interface: RBatch
    
    Defines attempts amount to re-send Redis commands batch if it hasn't been sent already.
    0 value means use Config.setRetryAttempts value instead.
    Default is 0
    
    Specified by:
    
    retryAttempts in interface RBatch
    
    Parameters:
    retryAttempts - value
    
    Returns:
    self instance
  - retryInterval
```
public RBatch retryInterval(long retryInterval,
                   TimeUnit unit)
```
    Description copied from interface: RBatch
    
    Defines time interval for another one attempt send Redis commands batch if it hasn't been sent already.
    0 value means use Config.setRetryInterval value instead.
    Default is 0
    
    Specified by:
    
    retryInterval in interface RBatch
    
    Parameters:
    retryInterval - value
    unit - value
    
    Returns:
    self instance
  - timeout
```
public RBatch timeout(long timeout,
             TimeUnit unit)
```
    Description copied from interface: RBatch
    
    Defines timeout for Redis response. Starts to countdown when Redis command has been successfully sent.
    0 value means use Config.setTimeout value instead.
    Default is 0
    
    Specified by:
    
    timeout in interface RBatch
    
    Parameters:
    timeout - value
    unit - value
    
    Returns:
    self instance
  - execute
```
public List<?> execute()
```
    Description copied from interface: RBatch
    
    Executes all operations accumulated during async methods invocations.
    If cluster configuration used then operations are grouped by slot ids and may be executed on different servers. Thus command execution order could be changed
    
    Specified by:
    
    execute in interface RBatch
    
    Returns:
    List with result object for each command
  - executeSkipResult
```
public void executeSkipResult()
```
    Description copied from interface: RBatch
    
    Executes all operations accumulated during async methods invocations. Command replies are skipped such approach saves response bandwidth.
    If cluster configuration used then operations are grouped by slot ids and may be executed on different servers. Thus command execution order could be changed.
    NOTE: Redis 3.2+ required
    
    Specified by:
    
    executeSkipResult in interface RBatch
  - executeSkipResultAsync
```
public RFuture<Void> executeSkipResultAsync()
```
    Description copied from interface: RBatch
    
    Executes all operations accumulated during async methods invocations asynchronously, Command replies are skipped such approach saves response bandwidth.
    If cluster configuration used then operations are grouped by slot ids and may be executed on different servers. Thus command execution order could be changed
    NOTE: Redis 3.2+ required
    
    Specified by:
    
    executeSkipResultAsync in interface RBatch
    
    Returns:
    void
  - executeAsync
```
public RFuture<List<?>> executeAsync()
```
    Description copied from interface: RBatch
    
    Executes all operations accumulated during async methods invocations asynchronously.
    In cluster configurations operations grouped by slot ids so may be executed on different servers. Thus command execution order could be changed
    
    Specified by:
    
    executeAsync in interface RBatch
    
    Returns:
    List with result object for each command
  - getSetMultimap
```
public <K,V> RMultimapAsync<K,V> getSetMultimap(String name)
```
    Description copied from interface: RBatch
    
    Returns Set based MultiMap instance by name.
    
    Specified by:
    
    getSetMultimap in interface RBatch
    
    Type Parameters:
    K - type of key
    V - type of value
    Parameters:
    name - - name of object
    
    Returns:
    Multimap object
  - getSetMultimap
```
public <K,V> RMultimapAsync<K,V> getSetMultimap(String name,
                                       Codec codec)
```
    Description copied from interface: RBatch
    
    Returns Set based MultiMap instance by name using provided codec for both map keys and values.
    
    Specified by:
    
    getSetMultimap in interface RBatch
    
    Type Parameters:
    K - type of key
    V - type of value
    Parameters:
    name - - name of object
    codec - - provided codec
    
    Returns:
    Multimap object
  - getListMultimap
```
public <K,V> RMultimapAsync<K,V> getListMultimap(String name)
```
    Description copied from interface: RBatch
    
    Returns List based MultiMap instance by name.
    
    Specified by:
    
    getListMultimap in interface RBatch
    
    Type Parameters:
    K - type of key
    V - type of value
    Parameters:
    name - - name of object
    
    Returns:
    ListMultimap object
  - getListMultimap
```
public <K,V> RMultimapAsync<K,V> getListMultimap(String name,
                                        Codec codec)
```
    Description copied from interface: RBatch
    
    Returns List based MultiMap instance by name using provided codec for both map keys and values.
    
    Specified by:
    
    getListMultimap in interface RBatch
    
    Type Parameters:
    K - type of key
    V - type of value
    Parameters:
    name - - name of object
    codec - - codec for keys and values
    
    Returns:
    ListMultimap object
  - getGeo
```
public <V> RGeoAsync<V> getGeo(String name)
```
    Description copied from interface: RBatch
    
    Returns geospatial items holder instance by name.
    
    Specified by:
    
    getGeo in interface RBatch
    
    Type Parameters:
    V - type of object
    Parameters:
    name - - name of object
    
    Returns:
    Geo object
  - getGeo
```
public <V> RGeoAsync<V> getGeo(String name,
                      Codec codec)
```
    Description copied from interface: RBatch
    
    Returns geospatial items holder instance by name using provided codec for geospatial members.
    
    Specified by:
    
    getGeo in interface RBatch
    
    Type Parameters:
    V - type of value
    Parameters:
    name - - name of object
    codec - - codec for value
    
    Returns:
    Geo object
  - getSetMultimapCache
```
public <K,V> RMultimapCacheAsync<K,V> getSetMultimapCache(String name)
```
    Description copied from interface: RBatch
    
    Returns Set based Multimap instance by name. Supports key-entry eviction with a given TTL value.
    If eviction is not required then it's better to use regular map RBatch.getSetMultimap(String).
    
    Specified by:
    
    getSetMultimapCache in interface RBatch
    
    Type Parameters:
    K - type of key
    V - type of value
    Parameters:
    name - - name of object
    
    Returns:
    SetMultimapCache object
  - getSetMultimapCache
```
public <K,V> RMultimapCacheAsync<K,V> getSetMultimapCache(String name,
                                                 Codec codec)
```
    Description copied from interface: RBatch
    
    Returns Set based Multimap instance by name using provided codec for both map keys and values. Supports key-entry eviction with a given TTL value.
    If eviction is not required then it's better to use regular map RBatch.getSetMultimap(String, Codec).
    
    Specified by:
    
    getSetMultimapCache in interface RBatch
    
    Type Parameters:
    K - type of key
    V - type of value
    Parameters:
    name - - name of object
    codec - - provided codec
    
    Returns:
    SetMultimapCache object
  - getListMultimapCache
```
public <K,V> RMultimapCacheAsync<K,V> getListMultimapCache(String name)
```
    Description copied from interface: RBatch
    
    Returns List based Multimap instance by name. Supports key-entry eviction with a given TTL value.
    If eviction is not required then it's better to use regular map RBatch.getSetMultimap(String).
    
    Specified by:
    
    getListMultimapCache in interface RBatch
    
    Type Parameters:
    K - type of key
    V - type of value
    Parameters:
    name - - name of object
    
    Returns:
    ListMultimapCache object
  - getListMultimapCache
```
public <K,V> RMultimapCacheAsync<K,V> getListMultimapCache(String name,
                                                  Codec codec)
```
    Description copied from interface: RBatch
    
    Returns List based Multimap instance by name using provided codec for both map keys and values. Supports key-entry eviction with a given TTL value.
    If eviction is not required then it's better to use regular map RBatch.getSetMultimap(String, Codec).
    
    Specified by:
    
    getListMultimapCache in interface RBatch
    
    Type Parameters:
    K - type of key
    V - type of value
    Parameters:
    name - - name of object
    codec - - codec for keys and values
    
    Returns:
    ListMultimapCache object
  - enableRedissonReferenceSupport
```
protected void enableRedissonReferenceSupport(Redisson redisson)
```

Class RedissonBatch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RedissonBatch

Method Detail

getBucket

getBucket

getHyperLogLog

getHyperLogLog

getList

getList

getMap

getMap

getSet

getSet

getTopic

getTopic

getQueue

getQueue

getBlockingQueue

getBlockingQueue

getBlockingDeque

getBlockingDeque

getDeque

getDeque

getAtomicLong

getAtomicDouble

getScoredSortedSet

getScoredSortedSet

getLexSortedSet

getBitSet

getMapCache

getMapCache

getScript

getKeys

getSetCache

getSetCache

retryAttempts

retryInterval

timeout

execute

executeSkipResult

executeSkipResultAsync

executeAsync

getSetMultimap

getSetMultimap

getListMultimap

getListMultimap

getGeo

getGeo

getSetMultimapCache

getSetMultimapCache

getListMultimapCache

getListMultimapCache

enableRedissonReferenceSupport