org.redisson

Class RedissonObject

java.lang.Object

org.redisson.RedissonObject

All Implemented Interfaces:

RObject, RObjectAsync

Direct Known Subclasses:

JCache, RedissonAtomicDouble, RedissonAtomicLong, RedissonBitSet, RedissonBloomFilter, RedissonBucket, RedissonCountDownLatch, RedissonDelayedQueue, RedissonHyperLogLog, RedissonList, RedissonListMultimapValues, RedissonLock, RedissonMap, RedissonMultimap, RedissonPermitExpirableSemaphore, RedissonReadWriteLock, RedissonScoredSortedSet, RedissonSemaphore, RedissonSet, RedissonSetCache, RedissonSetMultimapValues, RedissonSortedSet

public abstract class RedissonObject
extends Object
implements RObject

Base Redisson object

Author:

Nikita Koksharov

Field Summary

Fields

Modifier and Type	Field and Description
protected Codec	codec
protected CommandAsyncExecutor	commandExecutor

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected boolean	await(RFuture<?> future, long timeout, TimeUnit timeoutUnit)
boolean	delete() Deletes the object
RFuture<Boolean>	deleteAsync() Delete object in async mode
protected byte[]	encode(Object value)
protected byte[]	encodeMapKey(Object value)
protected byte[]	encodeMapValue(Object value)
protected <V> V	get(RFuture<V> future)
Codec	getCodec() Returns the underlying Codec used by this RObject
String	getName() Returns name of object
protected String	getName(Object o)
boolean	isExists() Check object existence
RFuture<Boolean>	isExistsAsync() Check object existence in async mode.
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)
protected String	prefixName(String prefix, String name)
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
protected String	suffixName(String name, String suffix)
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

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

await

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

Throws:

InterruptedException

prefixName

protected String prefixName(String prefix,
                            String name)

suffixName

protected String suffixName(String name,
                            String suffix)

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

getName

protected String getName(Object o)

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

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

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 byte[] encode(Object value)

encodeMapKey

protected byte[] encodeMapKey(Object value)

encodeMapValue

protected byte[] encodeMapValue(Object value)