java.lang.Object
- org.redisson.RedissonObject

All Implemented Interfaces:

RObject, RObjectAsync

Direct Known Subclasses:

JCache, RedissonAtomicDouble, RedissonAtomicLong, RedissonBaseAdder, RedissonBaseLock, RedissonBitSet, RedissonBloomFilter, RedissonBucket, RedissonCountDownLatch, RedissonDelayedQueue, RedissonHyperLogLog, RedissonIdGenerator, RedissonList, RedissonListMultimapValues, RedissonMap, RedissonMultimap, RedissonPermitExpirableSemaphore, RedissonRateLimiter, RedissonReadWriteLock, RedissonReliableTopic, RedissonScoredSortedSet, RedissonSemaphore, RedissonSet, RedissonSetCache, RedissonSetMultimapValues, RedissonSortedSet, RedissonStream, RedissonTimeSeries, RedissonTransferQueue
```
public abstract class RedissonObject
extends Object
implements RObject
```
Base Redisson object

Author:

Nikita Koksharov

Field Summary

Fields
Modifier and Type Field Description

protected Codec codec

protected CommandAsyncExecutor commandExecutor

protected String name

Constructor Summary

Constructors
Constructor	Description
`RedissonObject(Codec codec, CommandAsyncExecutor commandExecutor, String name)`
`RedissonObject(CommandAsyncExecutor commandExecutor, String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected <T extends ObjectListener> int`	`addListener(String name, T listener, BiConsumer<T,String> consumer)`
`int`	`addListener(ObjectListener listener)`	Adds object event listener
`protected <T extends ObjectListener> RFuture<Integer>`	`addListenerAsync(String name, T listener, BiConsumer<T,String> consumer)`
`RFuture<Integer>`	`addListenerAsync(ObjectListener listener)`	Adds object event listener
`void`	`copy(String host, int port, int database, long timeout)`	Copy object from source Redis instance to destination Redis instance
`RFuture<Void>`	`copyAsync(String host, int port, int database, long timeout)`	Copy object from source Redis instance to destination Redis instance in async mode
`boolean`	`delete()`	Deletes the object
`RFuture<Boolean>`	`deleteAsync()`	Delete object in async mode
`protected RFuture<Boolean>`	`deleteAsync(String... keys)`
`byte[]`	`dump()`	Returns dump of object
`RFuture<byte[]>`	`dumpAsync()`	Returns dump of object
`io.netty.buffer.ByteBuf`	`encode(Object value)`
`protected List<io.netty.buffer.ByteBuf>`	`encode(Object... values)`
`protected List<io.netty.buffer.ByteBuf>`	`encode(Collection<?> values)`
`void`	`encode(Collection<Object> params, Collection<?> values)`
`io.netty.buffer.ByteBuf`	`encodeMapKey(Object value)`
`protected void`	`encodeMapKeys(Collection<Object> params, Collection<?> values)`
`io.netty.buffer.ByteBuf`	`encodeMapValue(Object value)`
`protected void`	`encodeMapValues(Collection<Object> params, Collection<?> values)`
`protected <V> V`	`get(RFuture<V> future)`
`Codec`	`getCodec()`	Returns the underlying Codec used by this RObject
`Long`	`getIdleTime()`	Returns number of seconds spent since last write or read operation over this object.
`RFuture<Long>`	`getIdleTimeAsync()`	Returns number of seconds spent since last write or read operation over this object.
`String`	`getLockByMapKey(Object key, String suffix)`
`String`	`getLockByValue(Object key, String suffix)`
`String`	`getName()`	Returns name of object
`String`	`getRawName()`
`protected String`	`getRawName(Object o)`
`boolean`	`isExists()`	Check object existence
`RFuture<Boolean>`	`isExistsAsync()`	Check object existence in async mode.
`void`	`migrate(String host, int port, int database, long timeout)`	Copy object from source Redis instance to destination Redis instance
`RFuture<Void>`	`migrateAsync(String host, int port, int database, long timeout)`	Transfer 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
`static String`	`prefixName(String prefix, String name)`
`void`	`removeListener(int listenerId)`	Removes object event listener
`RFuture<Void>`	`removeListenerAsync(int listenerId)`	Removes object event listener
`protected void`	`removeListenersAsync(int listenerId, CountableListener<Void> listener)`
`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
`void`	`restore(byte[] state)`	Restores object using its state returned by `RObject.dump()` method.
`void`	`restore(byte[] state, long timeToLive, TimeUnit timeUnit)`	Restores object using its state returned by `RObject.dump()` method and set time to live for it.
`void`	`restoreAndReplace(byte[] state)`	Restores and replaces object if it already exists.
`void`	`restoreAndReplace(byte[] state, long timeToLive, TimeUnit timeUnit)`	Restores and replaces object if it already exists and set time to live for it.
`RFuture<Void>`	`restoreAndReplaceAsync(byte[] state)`	Restores and replaces object if it already exists.
`RFuture<Void>`	`restoreAndReplaceAsync(byte[] state, long timeToLive, TimeUnit timeUnit)`	Restores and replaces object if it already exists and set time to live for it.
`RFuture<Void>`	`restoreAsync(byte[] state)`	Restores object using its state returned by `RObjectAsync.dumpAsync()` method.
`RFuture<Void>`	`restoreAsync(byte[] state, long timeToLive, TimeUnit timeUnit)`	Restores object using its state returned by `RObjectAsync.dumpAsync()` method and set time to live for it.
`protected void`	`setName(String name)`
`long`	`sizeInMemory()`	Returns bytes amount used by object in Redis memory.
`RFuture<Long>`	`sizeInMemoryAsync()`	Returns bytes amount used by object in Redis memory.
`RFuture<Long>`	`sizeInMemoryAsync(List<Object> keys)`
`RFuture<Long>`	`sizeInMemoryAsync(CommandAsyncExecutor commandExecutor, List<Object> keys)`
`static String`	`suffixName(String name, String suffix)`
`protected long`	`toSeconds(long timeout, TimeUnit unit)`
`protected <T> Stream<T>`	`toStream(Iterator<T> iterator)`
`boolean`	`touch()`	Update the last access time of an object.
`RFuture<Boolean>`	`touchAsync()`	Update the last access time of an object in async mode.
`boolean`	`unlink()`	Delete the objects.
`RFuture<Boolean>`	`unlinkAsync()`	Delete the objects.

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

- Field Detail
  - commandExecutor
```
protected final CommandAsyncExecutor commandExecutor
```
  - name
```
protected String name
```
  - codec
```
protected final Codec codec
```
- Constructor Detail
  - RedissonObject
```
public RedissonObject(Codec codec,
                      CommandAsyncExecutor commandExecutor,
                      String name)
```
  - RedissonObject
```
public RedissonObject(CommandAsyncExecutor commandExecutor,
                      String name)
```
- Method Detail
  - prefixName
```
public static String prefixName(String prefix,
                                String name)
```
  - suffixName
```
public static String suffixName(String name,
                                String suffix)
```
  - toStream
```
protected final <T> Stream<T> toStream(Iterator<T> iterator)
```
  - get
```
protected final <V> V get(RFuture<V> future)
```
  - toSeconds
```
protected final long toSeconds(long timeout,
                               TimeUnit unit)
```
  - getName
```
public String getName()
```
    Description copied from interface: RObject
    
    Returns name of object
    
    Specified by:
    
    getName in interface RObject
    
    Returns:
    
    name - name of object
  - getRawName
```
public final String getRawName()
```
  - getRawName
```
protected String getRawName(Object o)
```
  - setName
```
protected final void setName(String name)
```
  - 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
  - sizeInMemoryAsync
```
public RFuture<Long> sizeInMemoryAsync()
```
    Description copied from interface: RObjectAsync
    
    Returns bytes amount used by object in Redis memory.
    
    Specified by:
    
    sizeInMemoryAsync in interface RObjectAsync
    
    Returns:
    
    size in bytes
  - sizeInMemoryAsync
```
public final RFuture<Long> sizeInMemoryAsync(List<Object> keys)
```
  - sizeInMemoryAsync
```
public final RFuture<Long> sizeInMemoryAsync(CommandAsyncExecutor commandExecutor,
                                             List<Object> keys)
```
  - sizeInMemory
```
public long sizeInMemory()
```
    Description copied from interface: RObject
    
    Returns bytes amount used by object in Redis memory.
    
    Specified by:
    
    sizeInMemory in interface RObject
    
    Returns:
    
    size in bytes
  - 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,
                    long timeout)
```
    Description copied from interface: RObject
    
    Copy 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
    
    timeout - - maximum idle time in any moment of the communication with the destination instance in milliseconds
  - 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
    
    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
  - copy
```
public void copy(String host,
                 int port,
                 int database,
                 long timeout)
```
    Description copied from interface: RObject
    
    Copy object from source Redis instance to destination Redis instance
    
    Specified by:
    
    copy in interface RObject
    
    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
  - copyAsync
```
public RFuture<Void> copyAsync(String host,
                               int port,
                               int database,
                               long timeout)
```
    Description copied from interface: RObjectAsync
    
    Copy object from source Redis instance to destination Redis instance in async mode
    
    Specified by:
    
    copyAsync in interface RObjectAsync
    
    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
  - 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
  - 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
  - deleteAsync
```
protected RFuture<Boolean> deleteAsync(String... keys)
```
  - unlink
```
public boolean unlink()
```
    Description copied from interface: RObject
    
    Delete the objects. Actual removal will happen later asynchronously.
    Requires Redis 4.0+
    
    Specified by:
    
    unlink in interface RObject
    
    Returns:
    
    true if it was exist and deleted else false
  - 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
    
    Returns:
    
    true if it was exist and deleted else false
  - touch
```
public boolean touch()
```
    Description copied from interface: RObject
    
    Update the last access time of an object.
    
    Specified by:
    
    touch in interface RObject
    
    Returns:
    
    true if object was touched else false
  - 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
    
    Returns:
    
    true if object was touched 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 List<io.netty.buffer.ByteBuf> encode(Object... values)
```
  - encode
```
protected List<io.netty.buffer.ByteBuf> encode(Collection<?> values)
```
  - encode
```
public void encode(Collection<Object> params,
                   Collection<?> values)
```
  - getLockByMapKey
```
public String getLockByMapKey(Object key,
                              String suffix)
```
  - getLockByValue
```
public String getLockByValue(Object key,
                             String suffix)
```
  - encodeMapKeys
```
protected void encodeMapKeys(Collection<Object> params,
                             Collection<?> values)
```
  - encodeMapValues
```
protected void encodeMapValues(Collection<Object> params,
                               Collection<?> values)
```
  - encode
```
public io.netty.buffer.ByteBuf encode(Object value)
```
  - encodeMapKey
```
public io.netty.buffer.ByteBuf encodeMapKey(Object value)
```
  - encodeMapValue
```
public io.netty.buffer.ByteBuf encodeMapValue(Object value)
```
  - dump
```
public byte[] dump()
```
    Description copied from interface: RObject
    
    Returns dump of object
    
    Specified by:
    
    dump in interface RObject
    
    Returns:
    
    dump
  - dumpAsync
```
public RFuture<byte[]> dumpAsync()
```
    Description copied from interface: RObjectAsync
    
    Returns dump of object
    
    Specified by:
    
    dumpAsync in interface RObjectAsync
    
    Returns:
    
    dump
  - restore
```
public void restore(byte[] state)
```
    Description copied from interface: RObject
    
    Restores object using its state returned by RObject.dump() method.
    
    Specified by:
    
    restore in interface RObject
    
    Parameters:
    
    state - - state of object
  - restoreAsync
```
public RFuture<Void> restoreAsync(byte[] state)
```
    Description copied from interface: RObjectAsync
    
    Restores object using its state returned by RObjectAsync.dumpAsync() method.
    
    Specified by:
    
    restoreAsync in interface RObjectAsync
    
    Parameters:
    
    state - - state of object
    
    Returns:
    
    void
  - restore
```
public void restore(byte[] state,
                    long timeToLive,
                    TimeUnit timeUnit)
```
    Description copied from interface: RObject
    
    Restores object using its state returned by RObject.dump() method and set time to live for it.
    
    Specified by:
    
    restore in interface RObject
    
    Parameters:
    
    state - - state of object
    
    timeToLive - - time to live of the object
    
    timeUnit - - time unit
  - restoreAsync
```
public RFuture<Void> restoreAsync(byte[] state,
                                  long timeToLive,
                                  TimeUnit timeUnit)
```
    Description copied from interface: RObjectAsync
    
    Restores object using its state returned by RObjectAsync.dumpAsync() method and set time to live for it.
    
    Specified by:
    
    restoreAsync in interface RObjectAsync
    
    Parameters:
    
    state - - state of object
    
    timeToLive - - time to live of the object
    
    timeUnit - - time unit
    
    Returns:
    
    void
  - restoreAndReplace
```
public void restoreAndReplace(byte[] state,
                              long timeToLive,
                              TimeUnit timeUnit)
```
    Description copied from interface: RObject
    
    Restores and replaces object if it already exists and set time to live for it.
    
    Specified by:
    
    restoreAndReplace in interface RObject
    
    Parameters:
    
    state - - state of the object
    
    timeToLive - - time to live of the object
    
    timeUnit - - time unit
  - restoreAndReplaceAsync
```
public RFuture<Void> restoreAndReplaceAsync(byte[] state,
                                            long timeToLive,
                                            TimeUnit timeUnit)
```
    Description copied from interface: RObjectAsync
    
    Restores and replaces object if it already exists and set time to live for it.
    
    Specified by:
    
    restoreAndReplaceAsync in interface RObjectAsync
    
    Parameters:
    
    state - - state of the object
    
    timeToLive - - time to live of the object
    
    timeUnit - - time unit
    
    Returns:
    
    void
  - restoreAndReplace
```
public void restoreAndReplace(byte[] state)
```
    Description copied from interface: RObject
    
    Restores and replaces object if it already exists.
    
    Specified by:
    
    restoreAndReplace in interface RObject
    
    Parameters:
    
    state - - state of the object
  - restoreAndReplaceAsync
```
public RFuture<Void> restoreAndReplaceAsync(byte[] state)
```
    Description copied from interface: RObjectAsync
    
    Restores and replaces object if it already exists.
    
    Specified by:
    
    restoreAndReplaceAsync in interface RObjectAsync
    
    Parameters:
    
    state - - state of the object
    
    Returns:
    
    void
  - getIdleTime
```
public Long getIdleTime()
```
    Description copied from interface: RObject
    
    Returns number of seconds spent since last write or read operation over this object.
    
    Specified by:
    
    getIdleTime in interface RObject
    
    Returns:
    
    number of seconds
  - getIdleTimeAsync
```
public RFuture<Long> getIdleTimeAsync()
```
    Description copied from interface: RObjectAsync
    
    Returns number of seconds spent since last write or read operation over this object.
    
    Specified by:
    
    getIdleTimeAsync in interface RObjectAsync
    
    Returns:
    
    number of seconds
  - addListener
```
protected final <T extends ObjectListener> int addListener(String name,
                                                           T listener,
                                                           BiConsumer<T,String> consumer)
```
  - addListenerAsync
```
protected final <T extends ObjectListener> RFuture<Integer> addListenerAsync(String name,
                                                                             T listener,
                                                                             BiConsumer<T,String> consumer)
```
  - addListener
```
public int addListener(ObjectListener listener)
```
    Description copied from interface: RObject
    
    Adds object event listener
    
    Specified by:
    
    addListener in interface RObject
    
    Parameters:
    
    listener - - object event listener
    
    Returns:
    
    listener id
    
    See Also:
    
    ExpiredObjectListener, DeletedObjectListener
  - addListenerAsync
```
public RFuture<Integer> addListenerAsync(ObjectListener listener)
```
    Description copied from interface: RObjectAsync
    
    Adds object event listener
    
    Specified by:
    
    addListenerAsync in interface RObjectAsync
    
    Parameters:
    
    listener - - object event listener
    
    Returns:
    
    listener id
    
    See Also:
    
    ExpiredObjectListener, DeletedObjectListener
  - removeListener
```
public void removeListener(int listenerId)
```
    Description copied from interface: RObject
    
    Removes object event listener
    
    Specified by:
    
    removeListener in interface RObject
    
    Parameters:
    
    listenerId - - listener id
  - removeListenerAsync
```
public RFuture<Void> removeListenerAsync(int listenerId)
```
    Description copied from interface: RObjectAsync
    
    Removes object event listener
    
    Specified by:
    
    removeListenerAsync in interface RObjectAsync
    
    Parameters:
    
    listenerId - - listener id
  - removeListenersAsync
```
protected final void removeListenersAsync(int listenerId,
                                          CountableListener<Void> listener)
```

Modifier and Type	Field	Description
`protected Codec`	`codec`
`protected CommandAsyncExecutor`	`commandExecutor`
`protected String`	`name`

Class RedissonObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

commandExecutor

name

codec

Constructor Detail

RedissonObject

RedissonObject

Method Detail

prefixName

suffixName

toStream

get

toSeconds

getName

getRawName

getRawName

setName

rename

sizeInMemoryAsync

sizeInMemoryAsync

sizeInMemoryAsync

sizeInMemory

renameAsync

migrate

migrateAsync

copy

copyAsync

move

moveAsync

renamenx

renamenxAsync

delete

deleteAsync

deleteAsync

unlink

unlinkAsync

touch

touchAsync

isExists

isExistsAsync

getCodec

encode

encode

encode

getLockByMapKey

getLockByValue

encodeMapKeys

encodeMapValues

encode

encodeMapKey

encodeMapValue

dump

dumpAsync

restore

restoreAsync

restore

restoreAsync

restoreAndReplace

restoreAndReplaceAsync

restoreAndReplace

restoreAndReplaceAsync

getIdleTime

getIdleTimeAsync

addListener

addListenerAsync

addListener

addListenerAsync

removeListener

removeListenerAsync

removeListenersAsync