org.redisson.api

Interface RObject

All Superinterfaces:

RObjectAsync

All Known Subinterfaces:

RAtomicDouble, RAtomicLong, RBinaryStream, RBitSet, RBlockingDeque<V>, RBlockingQueue<V>, RBloomFilter<T>, RBoundedBlockingQueue<V>, RBucket<V>, RCountDownLatch, RDelayedQueue<V>, RDeque<V>, RDoubleAdder, RExpirable, RGeo<V>, RHyperLogLog<V>, RIdGenerator, RLexSortedSet, RList<V>, RListMultimap<K,V>, RListMultimapCache<K,V>, RLiveObject, RLocalCachedMap<K,V>, RLongAdder, RMap<K,V>, RMapCache<K,V>, RMultimap<K,V>, RMultimapCache<K,V>, RPermitExpirableSemaphore, RPriorityBlockingDeque<V>, RPriorityBlockingQueue<V>, RPriorityDeque<V>, RPriorityQueue<V>, RQueue<V>, RRateLimiter, RReliableTopic, RRingBuffer<V>, RScoredSortedSet<V>, RSemaphore, RSet<V>, RSetCache<V>, RSetMultimap<K,V>, RSetMultimapCache<K,V>, RSortedSet<V>, RStream<K,V>, RTimeSeries<V>, RTransferQueue<V>

All Known Implementing Classes:

JCache, RedissonAtomicDouble, RedissonAtomicLong, RedissonBaseAdder, RedissonBaseLock, RedissonBinaryStream, RedissonBitSet, RedissonBlockingDeque, RedissonBlockingQueue, RedissonBloomFilter, RedissonBoundedBlockingQueue, RedissonBucket, RedissonCountDownLatch, RedissonDelayedQueue, RedissonDeque, RedissonDoubleAdder, RedissonFairLock, RedissonGeo, RedissonHyperLogLog, RedissonIdGenerator, RedissonLexSortedSet, RedissonList, RedissonListMultimap, RedissonListMultimapCache, RedissonListMultimapValues, RedissonLocalCachedMap, RedissonLock, RedissonLongAdder, RedissonMap, RedissonMapCache, RedissonMultimap, RedissonObject, RedissonPermitExpirableSemaphore, RedissonPriorityBlockingDeque, RedissonPriorityBlockingQueue, RedissonPriorityDeque, RedissonPriorityQueue, RedissonQueue, RedissonQueueSemaphore, RedissonRateLimiter, RedissonReadLock, RedissonReadWriteLock, RedissonReliableTopic, RedissonRingBuffer, RedissonScoredSortedSet, RedissonSemaphore, RedissonSet, RedissonSetCache, RedissonSetMultimap, RedissonSetMultimapCache, RedissonSetMultimapValues, RedissonSortedSet, RedissonSpinLock, RedissonStream, RedissonSubList, RedissonTimeSeries, RedissonTransactionalBucket, RedissonTransactionalLocalCachedMap, RedissonTransactionalLock, RedissonTransactionalMap, RedissonTransactionalMapCache, RedissonTransactionalSet, RedissonTransactionalSetCache, RedissonTransferQueue, RedissonWriteLock

public interface RObject
extends RObjectAsync

Base interface for all Redisson objects

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method and Description
int	addListener(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
boolean	delete() Deletes the object
byte[]	dump() Returns dump of object
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.
String	getName() Returns name of object
boolean	isExists() Check object existence
void	migrate(String host, int port, int database, long timeout) Copy object from source Redis instance to destination Redis instance
boolean	move(int database) Move object to another database
void	removeListener(int listenerId) Removes object event listener
void	rename(String newName) Rename current object key to newName
boolean	renamenx(String newName) Rename current object key to newName only if new key is not exists
void	restore(byte[] state) Restores object using its state returned by dump() method.
void	restore(byte[] state, long timeToLive, TimeUnit timeUnit) Restores object using its state returned by 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.
long	sizeInMemory() Returns bytes amount used by object in Redis memory.
boolean	touch() Update the last access time of an object.
boolean	unlink() Delete the objects.

Methods inherited from interface org.redisson.api.RObjectAsync

addListenerAsync, copyAsync, deleteAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Method Detail

getIdleTime

Long getIdleTime()

Returns number of seconds spent since last write or read operation over this object.

Returns:

number of seconds

sizeInMemory

long sizeInMemory()

Returns bytes amount used by object in Redis memory.

Returns:

size in bytes

restore

void restore(byte[] state)

Restores object using its state returned by dump() method.

Parameters:

state - - state of object

restore

void restore(byte[] state,
             long timeToLive,
             TimeUnit timeUnit)

Restores object using its state returned by dump() method and set time to live for it.

Parameters:

state - - state of object

timeToLive - - time to live of the object

timeUnit - - time unit

restoreAndReplace

void restoreAndReplace(byte[] state)

Restores and replaces object if it already exists.

Parameters:

state - - state of the object

restoreAndReplace

void restoreAndReplace(byte[] state,
                       long timeToLive,
                       TimeUnit timeUnit)

Restores and replaces object if it already exists and set time to live for it.

Parameters:

state - - state of the object

timeToLive - - time to live of the object

timeUnit - - time unit

dump

byte[] dump()

Returns dump of object

Returns:

dump

touch

boolean touch()

Update the last access time of an object.

Returns:

true if object was touched else false

migrate

void migrate(String host,
             int port,
             int database,
             long timeout)

Copy object from source Redis instance to destination Redis instance

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

copy

void copy(String host,
          int port,
          int database,
          long timeout)

Copy object from source Redis instance to destination Redis instance

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

move

boolean move(int database)

Move object to another database

Parameters:

database - - Redis database number

Returns:

true if key was moved else false

getName

String getName()

Returns name of object

Returns:

name - name of object

delete

boolean delete()

Deletes the object

Returns:

true if it was exist and deleted else false

unlink

boolean unlink()

Delete the objects. Actual removal will happen later asynchronously.

Requires Redis 4.0+

Returns:

true if it was exist and deleted else false

rename

void rename(String newName)

Rename current object key to newName

Parameters:

newName - - new name of object

renamenx

boolean renamenx(String newName)

Rename current object key to newName only if new key is not exists

Parameters:

newName - - new name of object

Returns:

true if object has been renamed successfully and false otherwise

isExists

boolean isExists()

Check object existence

Returns:

true if object exists and false otherwise

getCodec

Codec getCodec()

Returns the underlying Codec used by this RObject

Returns:

Codec of object

addListener

int addListener(ObjectListener listener)

Adds object event listener

Parameters:

listener - - object event listener

Returns:

listener id

See Also:

ExpiredObjectListener, DeletedObjectListener

removeListener

void removeListener(int listenerId)

Removes object event listener

Parameters:

listenerId - - listener id