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 and Description
RedissonBucket(Codec codec, CommandAsyncExecutor connectionManager, String name)
RedissonBucket(CommandAsyncExecutor connectionManager, String name)

Method Summary

Modifier and Type	Method and 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)
RFuture<Boolean>	compareAndSetAsync(V expect, V update)
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(Date timestamp) Set an expire date for object.
boolean	expireAt(long timestamp) Set an expire date for object.
RFuture<Boolean>	expireAtAsync(Date timestamp) Set an expire date for object in async mode.
RFuture<Boolean>	expireAtAsync(long timestamp) Set an expire date for object in async mode.
V	get()
V	getAndDelete()
RFuture<V>	getAndDeleteAsync()
V	getAndSet(V newValue)
RFuture<V>	getAndSetAsync(V newValue)
RFuture<V>	getAsync()
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)
void	set(V value, long timeToLive, TimeUnit timeUnit)
RFuture<Void>	setAsync(V value)
RFuture<Void>	setAsync(V value, long timeToLive, TimeUnit timeUnit)
long	size() Returns size of object in bytes
RFuture<Long>	sizeAsync() Returns size of object in bytes
boolean	trySet(V value)
boolean	trySet(V value, long timeToLive, TimeUnit timeUnit)
RFuture<Boolean>	trySetAsync(V value)
RFuture<Boolean>	trySetAsync(V value, long timeToLive, TimeUnit timeUnit)

Methods inherited from class org.redisson.RedissonObject

await, copy, copyAsync, delete, deleteAsync, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getName, getName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, rename, renameAsync, renamenx, renamenxAsync, 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.RObject

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

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

copyAsync, deleteAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, 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)

Specified by:

compareAndSet in interface RBucket<V>

compareAndSetAsync

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

Specified by:

compareAndSetAsync in interface RBucketAsync<V>

getAndSet

public V getAndSet(V newValue)

Specified by:

getAndSet in interface RBucket<V>

getAndSetAsync

public RFuture<V> getAndSetAsync(V newValue)

Specified by:

getAndSetAsync in interface RBucketAsync<V>

get

public V get()

Specified by:

get in interface RBucket<V>

getAsync

public RFuture<V> getAsync()

Specified by:

getAsync in interface RBucketAsync<V>

getAndDelete

public V getAndDelete()

Specified by:

getAndDelete in interface RBucket<V>

getAndDeleteAsync

public RFuture<V> getAndDeleteAsync()

Specified by:

getAndDeleteAsync in interface RBucketAsync<V>

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)

Specified by:

set in interface RBucket<V>

setAsync

public RFuture<Void> setAsync(V value)

Specified by:

setAsync in interface RBucketAsync<V>

set

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

Specified by:

set in interface RBucket<V>

setAsync

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

Specified by:

setAsync in interface RBucketAsync<V>

trySetAsync

public RFuture<Boolean> trySetAsync(V value)

Specified by:

trySetAsync in interface RBucketAsync<V>

trySetAsync

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

Specified by:

trySetAsync in interface RBucketAsync<V>

trySet

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

Specified by:

trySet in interface RBucket<V>

trySet

public boolean trySet(V value)

Specified by:

trySet in interface RBucket<V>

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 seconds (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.