Package org.redisson

Class RedissonBucket<V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonBucket<V>

Type Parameters:

V - value type

All Implemented Interfaces:

RBucket<V>, RBucketAsync<V>, RExpirable, RExpirableAsync, RObject, RObjectAsync

Direct Known Subclasses:

RedissonBinaryStream, RedissonTransactionalBucket

public class RedissonBucket<V>
extends RedissonObject
implements RBucket<V>

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor

Constructor Summary

Constructors

Constructor	Description
RedissonBucket(Codec codec, CommandAsyncExecutor connectionManager, String name)
RedissonBucket(CommandAsyncExecutor connectionManager, String name)

Method Summary

Modifier and Type	Method	Description
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.
boolean	compareAndSet(V expect, V update)	Atomically sets the value to the given updated value only if serialized state of the current value equals to serialized state of the expected value.
RFuture<Boolean>	compareAndSetAsync(V expect, V update)	Atomically sets the value to the given updated value only if serialized state of the current value equals to serialized state of the expected value.
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(long timestamp)	Set an expire date for object.
boolean	expireAt(Date timestamp)	Set an expire date for object.
RFuture<Boolean>	expireAtAsync(long timestamp)	Set an expire date for object in async mode.
RFuture<Boolean>	expireAtAsync(Date timestamp)	Set an expire date for object in async mode.
V	get()	Retrieves element stored in the holder.
V	getAndDelete()	Retrieves element in the holder and removes it.
RFuture<V>	getAndDeleteAsync()	Retrieves element in the holder and removes it.
V	getAndSet(V newValue)	Retrieves current element in the holder and replaces it with newValue.
RFuture<V>	getAndSetAsync(V newValue)	Retrieves current element in the holder and replaces it with newValue.
RFuture<V>	getAsync()	Retrieves element stored in the holder.
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
void	set(V value)	Stores element into the holder.
void	set(V value, long timeToLive, TimeUnit timeUnit)	Stores element into the holder with defined timeToLive interval.
RFuture<Void>	setAsync(V value)	Stores element into the holder.
RFuture<Void>	setAsync(V value, long timeToLive, TimeUnit timeUnit)	Stores element into the holder with defined timeToLive interval.
long	size()	Returns size of object in bytes.
RFuture<Long>	sizeAsync()	Returns size of object in bytes
boolean	trySet(V value)	Tries to set element atomically into empty holder.
boolean	trySet(V value, long timeToLive, TimeUnit timeUnit)	Tries to set element atomically into empty holder with defined timeToLive interval.
RFuture<Boolean>	trySetAsync(V value)	Tries to set element atomically into empty holder.
RFuture<Boolean>	trySetAsync(V value, long timeToLive, TimeUnit timeUnit)	Tries to set element atomically into empty holder with defined timeToLive interval.

Methods inherited from class org.redisson.RedissonObject

await, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getName, getName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, suffixName, toSeconds, touch, touchAsync, unlink, unlinkAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

copy, delete, dump, getCodec, getName, isExists, migrate, move, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, touch, unlink

Methods inherited from interface org.redisson.api.RObjectAsync

copyAsync, deleteAsync, dumpAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, touchAsync, unlinkAsync

Constructor Detail

RedissonBucket

public RedissonBucket(CommandAsyncExecutor connectionManager,
                      String name)

RedissonBucket

public RedissonBucket(Codec codec,
                      CommandAsyncExecutor connectionManager,
                      String name)

Method Detail

compareAndSet

public boolean compareAndSet(V expect,
                             V update)

Description copied from interface: RBucket

Atomically sets the value to the given updated value only if serialized state of the current value equals to serialized state of the expected value.

Specified by:

compareAndSet in interface RBucket<V>

Parameters:

expect - the expected value

update - the new value

Returns:

true if successful; or false if the actual value was not equal to the expected value.

compareAndSetAsync

public RFuture<Boolean> compareAndSetAsync(V expect,
                                           V update)

Description copied from interface: RBucketAsync

Atomically sets the value to the given updated value only if serialized state of the current value equals to serialized state of the expected value.

Specified by:

compareAndSetAsync in interface RBucketAsync<V>

Parameters:

expect - the expected value

update - the new value

Returns:

true if successful; or false if the actual value was not equal to the expected value.

getAndSet

public V getAndSet(V newValue)

Description copied from interface: RBucket

Retrieves current element in the holder and replaces it with newValue.

Specified by:

getAndSet in interface RBucket<V>

Parameters:

newValue - - value to set

Returns:

previous value

getAndSetAsync

public RFuture<V> getAndSetAsync(V newValue)

Description copied from interface: RBucketAsync

Retrieves current element in the holder and replaces it with newValue.

Specified by:

getAndSetAsync in interface RBucketAsync<V>

Parameters:

newValue - - value to set

Returns:

previous value

get

public V get()

Description copied from interface: RBucket

Retrieves element stored in the holder.

Specified by:

get in interface RBucket<V>

Returns:

element

getAsync

public RFuture<V> getAsync()

Description copied from interface: RBucketAsync

Retrieves element stored in the holder.

Specified by:

getAsync in interface RBucketAsync<V>

Returns:

element

getAndDelete

public V getAndDelete()

Description copied from interface: RBucket

Retrieves element in the holder and removes it.

Specified by:

getAndDelete in interface RBucket<V>

Returns:

element

getAndDeleteAsync

public RFuture<V> getAndDeleteAsync()

Description copied from interface: RBucketAsync

Retrieves element in the holder and removes it.

Specified by:

getAndDeleteAsync in interface RBucketAsync<V>

Returns:

element

size

public long size()

Description copied from interface: RBucket

Returns size of object in bytes.

Specified by:

size in interface RBucket<V>

Returns:

object size

sizeAsync

public RFuture<Long> sizeAsync()

Description copied from interface: RBucketAsync

Returns size of object in bytes

Specified by:

sizeAsync in interface RBucketAsync<V>

Returns:

object size

set

public void set(V value)

Description copied from interface: RBucket

Stores element into the holder.

Specified by:

set in interface RBucket<V>

Parameters:

value - - value to set

setAsync

public RFuture<Void> setAsync(V value)

Description copied from interface: RBucketAsync

Stores element into the holder.

Specified by:

setAsync in interface RBucketAsync<V>

Parameters:

value - - value to set

Returns:

void

set

public void set(V value,
                long timeToLive,
                TimeUnit timeUnit)

Description copied from interface: RBucket

Stores element into the holder with defined timeToLive interval.

Specified by:

set in interface RBucket<V>

Parameters:

value - - value to set

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

setAsync

public RFuture<Void> setAsync(V value,
                              long timeToLive,
                              TimeUnit timeUnit)

Description copied from interface: RBucketAsync

Stores element into the holder with defined timeToLive interval.

Specified by:

setAsync in interface RBucketAsync<V>

Parameters:

value - - value to set

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

Returns:

void

trySetAsync

public RFuture<Boolean> trySetAsync(V value)

Description copied from interface: RBucketAsync

Tries to set element atomically into empty holder.

Specified by:

trySetAsync in interface RBucketAsync<V>

Parameters:

value - - value to set

Returns:

true if successful, or false if element was already set

trySetAsync

public RFuture<Boolean> trySetAsync(V value,
                                    long timeToLive,
                                    TimeUnit timeUnit)

Description copied from interface: RBucketAsync

Tries to set element atomically into empty holder with defined timeToLive interval.

Specified by:

trySetAsync in interface RBucketAsync<V>

Parameters:

value - - value to set

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

Returns:

true if successful, or false if element was already set

trySet

public boolean trySet(V value,
                      long timeToLive,
                      TimeUnit timeUnit)

Description copied from interface: RBucket

Tries to set element atomically into empty holder with defined timeToLive interval.

Specified by:

trySet in interface RBucket<V>

Parameters:

value - - value to set

timeToLive - - time to live interval

timeUnit - - unit of time to live interval

Returns:

true if successful, or false if element was already set

trySet

public boolean trySet(V value)

Description copied from interface: RBucket

Tries to set element atomically into empty holder.

Specified by:

trySet in interface RBucket<V>

Parameters:

value - - value to set

Returns:

true if successful, or false if element was already set

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

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

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

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 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

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

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

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

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.