Package org.redisson
Class RedissonBucket<V>
-
- 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, name
-
-
Constructor Summary
Constructors Constructor Description RedissonBucket(Codec codec, CommandAsyncExecutor connectionManager, name)
RedissonBucket(CommandAsyncExecutor connectionManager, name)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
addListener(ObjectListener listener)
Adds object event listener>
addListenerAsync(ObjectListener listener)
Adds object event listenerboolean
clearExpire()
Clear an expire timeout or expire date for object.>
clearExpireAsync()
Clear an expire timeout or expire date for object in async mode.protected >
... keys)
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.>
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)
Set a timeout for object.boolean
instant)
Set an expire date for object.>
expireAsync(long timeToLive, timeUnit)
Set a timeout for object in async mode.protected >
expireAsync(long timeToLive, timeUnit, ... keys)
>
instant)
Set an expire date for object.boolean
expireAt(long timestamp)
UseRExpirable.expire(Instant)
insteadboolean
timestamp)
UseRExpirable.expire(Instant)
instead>
expireAtAsync(long timestamp)
UseRExpirableAsync.expireAsync(Instant)
insteadprotected >
expireAtAsync(long timestamp, ... keys)
>
timestamp)
UseRExpirableAsync.expireAsync(Instant)
insteadV
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 withnewValue
.V
getAndSet(V value, long timeToLive, timeUnit)
Retrieves current element in the holder and replaces it withnewValue
with definedtimeToLive
interval.RFuture<V>
getAndSetAsync(V newValue)
Retrieves current element in the holder and replaces it withnewValue
.RFuture<V>
getAndSetAsync(V value, long timeToLive, timeUnit)
Retrieves current element in the holder and replaces it withnewValue
with definedtimeToLive
interval.RFuture<V>
getAsync()
Retrieves element stored in the holder.long
remainTimeToLive()
Remaining time to live of Redisson object that has a timeout>
remainTimeToLiveAsync()
Remaining time to live of Redisson object that has a timeoutvoid
removeListener(int listenerId)
Removes object event listener>
removeListenerAsync(int listenerId)
Removes object event listenervoid
set(V value)
Stores element into the holder.void
set(V value, long timeToLive, timeUnit)
Stores element into the holder with definedtimeToLive
interval.void
setAndKeepTTL(V value)
Set value and keep existing TTL.>
setAndKeepTTLAsync(V value)
Set value and keep existing TTL.>
setAsync(V value)
Stores element into the holder.>
setAsync(V value, long timeToLive, timeUnit)
Stores element into the holder with definedtimeToLive
interval.boolean
setIfExists(V value)
Sets value only if it's already exists.boolean
setIfExists(V value, long timeToLive, timeUnit)
Sets value only if it's already exists.>
setIfExistsAsync(V value)
Sets value only if it's already exists.>
setIfExistsAsync(V value, long timeToLive, timeUnit)
Sets value only if it's already exists.long
size()
Returns size of object in bytes.>
sizeAsync()
Returns size of object in bytesboolean
trySet(V value)
Tries to set element atomically into empty holder.boolean
trySet(V value, long timeToLive, timeUnit)
Tries to set element atomically into empty holder with definedtimeToLive
interval.>
trySetAsync(V value)
Tries to set element atomically into empty holder.>
trySetAsync(V value, long timeToLive, timeUnit)
Tries to set element atomically into empty holder with definedtimeToLive
interval.-
Methods inherited from class org.redisson.RedissonObject
addListener, addListenerAsync, copy, copyAsync, delete, deleteAsync, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, removeListenersAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync
-
Methods inherited from interface org.redisson.api.RExpirable
clearExpire, expire, expire, expireAt, expireAt, remainTimeToLive
-
Methods inherited from interface org.redisson.api.RExpirableAsync
clearExpireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync
-
Methods inherited from interface org.redisson.api.RObject
copy, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink
-
Methods inherited from interface org.redisson.api.RObjectAsync
copyAsync, deleteAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync
-
-
-
-
Constructor Detail
-
RedissonBucket
public RedissonBucket(CommandAsyncExecutor connectionManager, name)
-
RedissonBucket
public RedissonBucket(Codec codec, CommandAsyncExecutor connectionManager, 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 interfaceRBucket<V>
- Parameters:
expect
- the expected valueupdate
- the new value- Returns:
true
if successful; orfalse
if the actual value was not equal to the expected value.
-
compareAndSetAsync
public > 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 interfaceRBucketAsync<V>
- Parameters:
expect
- the expected valueupdate
- the new value- Returns:
true
if successful; orfalse
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 withnewValue
.
-
getAndSetAsync
public RFuture<V> getAndSetAsync(V newValue)
Description copied from interface:RBucketAsync
Retrieves current element in the holder and replaces it withnewValue
.- Specified by:
getAndSetAsync
in interfaceRBucketAsync<V>
- Parameters:
newValue
- - value to set- Returns:
- previous value
-
get
public V get()
Description copied from interface:RBucket
Retrieves element stored in the holder.
-
getAsync
public RFuture<V> getAsync()
Description copied from interface:RBucketAsync
Retrieves element stored in the holder.- Specified by:
getAsync
in interfaceRBucketAsync<V>
- Returns:
- element
-
getAndDelete
public V getAndDelete()
Description copied from interface:RBucket
Retrieves element in the holder and removes it.- Specified by:
getAndDelete
in interfaceRBucket<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 interfaceRBucketAsync<V>
- Returns:
- element
-
size
public long size()
Description copied from interface:RBucket
Returns size of object in bytes.
-
sizeAsync
public > sizeAsync()
Description copied from interface:RBucketAsync
Returns size of object in bytes- Specified by:
sizeAsync
in interfaceRBucketAsync<V>
- Returns:
- object size
-
set
public void set(V value)
Description copied from interface:RBucket
Stores element into the holder.
-
setAsync
public > setAsync(V value)
Description copied from interface:RBucketAsync
Stores element into the holder.- Specified by:
setAsync
in interfaceRBucketAsync<V>
- Parameters:
value
- - value to set- Returns:
- void
-
set
public void set(V value, long timeToLive, timeUnit)
Description copied from interface:RBucket
Stores element into the holder with definedtimeToLive
interval.
-
setAsync
public > setAsync(V value, long timeToLive, timeUnit)
Description copied from interface:RBucketAsync
Stores element into the holder with definedtimeToLive
interval.- Specified by:
setAsync
in interfaceRBucketAsync<V>
- Parameters:
value
- - value to settimeToLive
- - time to live intervaltimeUnit
- - unit of time to live interval- Returns:
- void
-
trySetAsync
public > trySetAsync(V value)
Description copied from interface:RBucketAsync
Tries to set element atomically into empty holder.- Specified by:
trySetAsync
in interfaceRBucketAsync<V>
- Parameters:
value
- - value to set- Returns:
true
if successful, orfalse
if element was already set
-
trySetAsync
public > trySetAsync(V value, long timeToLive, timeUnit)
Description copied from interface:RBucketAsync
Tries to set element atomically into empty holder with definedtimeToLive
interval.- Specified by:
trySetAsync
in interfaceRBucketAsync<V>
- Parameters:
value
- - value to settimeToLive
- - time to live intervaltimeUnit
- - unit of time to live interval- Returns:
true
if successful, orfalse
if element was already set
-
trySet
public boolean trySet(V value, long timeToLive, timeUnit)
Description copied from interface:RBucket
Tries to set element atomically into empty holder with definedtimeToLive
interval.
-
trySet
public boolean trySet(V value)
Description copied from interface:RBucket
Tries to set element atomically into empty holder.
-
setIfExists
public boolean setIfExists(V value)
Description copied from interface:RBucket
Sets value only if it's already exists.- Specified by:
setIfExists
in interfaceRBucket<V>
- Parameters:
value
- - value to set- Returns:
true
if successful, orfalse
if element wasn't set
-
setIfExistsAsync
public > setIfExistsAsync(V value)
Description copied from interface:RBucketAsync
Sets value only if it's already exists.- Specified by:
setIfExistsAsync
in interfaceRBucketAsync<V>
- Parameters:
value
- - value to set- Returns:
true
if successful, orfalse
if element wasn't set
-
setAndKeepTTL
public void setAndKeepTTL(V value)
Description copied from interface:RBucket
Set value and keep existing TTL.Requires Redis 6.0.0 and higher.
- Specified by:
setAndKeepTTL
in interfaceRBucket<V>
- Parameters:
value
- - value to set
-
setAndKeepTTLAsync
public > setAndKeepTTLAsync(V value)
Description copied from interface:RBucketAsync
Set value and keep existing TTL.Requires Redis 6.0.0 and higher.
- Specified by:
setAndKeepTTLAsync
in interfaceRBucketAsync<V>
- Parameters:
value
- - value to set- Returns:
- void
-
setIfExists
public boolean setIfExists(V value, long timeToLive, timeUnit)
Description copied from interface:RBucket
Sets value only if it's already exists.- Specified by:
setIfExists
in interfaceRBucket<V>
- Parameters:
value
- - value to settimeToLive
- - time to live intervaltimeUnit
- - unit of time to live interval- Returns:
true
if successful, orfalse
if element wasn't set
-
setIfExistsAsync
public > setIfExistsAsync(V value, long timeToLive, timeUnit)
Description copied from interface:RBucketAsync
Sets value only if it's already exists.- Specified by:
setIfExistsAsync
in interfaceRBucketAsync<V>
- Parameters:
value
- - value to settimeToLive
- - time to live intervaltimeUnit
- - unit of time to live interval- Returns:
true
if successful, orfalse
if element wasn't set
-
getAndSetAsync
public RFuture<V> getAndSetAsync(V value, long timeToLive, timeUnit)
Description copied from interface:RBucketAsync
Retrieves current element in the holder and replaces it withnewValue
with definedtimeToLive
interval.- Specified by:
getAndSetAsync
in interfaceRBucketAsync<V>
- Parameters:
value
- - value to settimeToLive
- - time to live intervaltimeUnit
- - unit of time to live interval- Returns:
- previous value
-
getAndSet
public V getAndSet(V value, long timeToLive, timeUnit)
Description copied from interface:RBucket
Retrieves current element in the holder and replaces it withnewValue
with definedtimeToLive
interval.
-
addListener
public int addListener(ObjectListener listener)
Description copied from interface:RObject
Adds object event listener- Specified by:
addListener
in interfaceRBucket<V>
- Specified by:
addListener
in interfaceRObject
- Overrides:
addListener
in classRedissonObject
- Parameters:
listener
- - object event listener- Returns:
- listener id
- See Also:
ExpiredObjectListener
,DeletedObjectListener
-
addListenerAsync
public > addListenerAsync(ObjectListener listener)
Description copied from interface:RObjectAsync
Adds object event listener- Specified by:
addListenerAsync
in interfaceRBucketAsync<V>
- Specified by:
addListenerAsync
in interfaceRObjectAsync
- Overrides:
addListenerAsync
in classRedissonObject
- 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 interfaceRObject
- Overrides:
removeListener
in classRedissonObject
- Parameters:
listenerId
- - listener id
-
removeListenerAsync
public > removeListenerAsync(int listenerId)
Description copied from interface:RObjectAsync
Removes object event listener- Specified by:
removeListenerAsync
in interfaceRObjectAsync
- Overrides:
removeListenerAsync
in classRedissonObject
- Parameters:
listenerId
- - listener id
-
expire
public boolean expire(long timeToLive, 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 interfaceRExpirable
- Parameters:
timeToLive
- - timeout before object will be deletedtimeUnit
- - timeout time unit- Returns:
true
if the timeout was set andfalse
if not
-
expireAsync
public > expireAsync(long timeToLive, 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 interfaceRExpirableAsync
- Parameters:
timeToLive
- - timeout before object will be deletedtimeUnit
- - timeout time unit- Returns:
true
if the timeout was set andfalse
if not
-
expireAt
public boolean expireAt(long timestamp)
Description copied from interface:RExpirable
UseRExpirable.expire(Instant)
instead- Specified by:
expireAt
in interfaceRExpirable
- Parameters:
timestamp
- - expire date in milliseconds (Unix timestamp)- Returns:
true
if the timeout was set andfalse
if not
-
expireAtAsync
public > expireAtAsync(long timestamp)
Description copied from interface:RExpirableAsync
UseRExpirableAsync.expireAsync(Instant)
instead- Specified by:
expireAtAsync
in interfaceRExpirableAsync
- Parameters:
timestamp
- - expire date in milliseconds (Unix timestamp)- Returns:
true
if the timeout was set andfalse
if not
-
expire
public boolean expire( instant)
Description copied from interface:RExpirable
Set an expire date for object. When expire date comes the key will automatically be deleted.- Specified by:
expire
in interfaceRExpirable
- Parameters:
instant
- - expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireAsync
public > expireAsync( instant)
Description copied from interface:RExpirableAsync
Set an expire date for object. When expire date comes the key will automatically be deleted.- Specified by:
expireAsync
in interfaceRExpirableAsync
- Parameters:
instant
- - expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireAt
public boolean expireAt( timestamp)
Description copied from interface:RExpirable
UseRExpirable.expire(Instant)
instead- Specified by:
expireAt
in interfaceRExpirable
- Parameters:
timestamp
- - expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireAtAsync
public > expireAtAsync( timestamp)
Description copied from interface:RExpirableAsync
UseRExpirableAsync.expireAsync(Instant)
instead- Specified by:
expireAtAsync
in interfaceRExpirableAsync
- Parameters:
timestamp
- - expire date- Returns:
true
if the timeout was set andfalse
if not
-
clearExpire
public boolean clearExpire()
Description copied from interface:RExpirable
Clear an expire timeout or expire date for object.- Specified by:
clearExpire
in interfaceRExpirable
- Returns:
true
if timeout was removedfalse
if object does not exist or does not have an associated timeout
-
clearExpireAsync
public > 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 interfaceRExpirableAsync
- Returns:
true
if the timeout was cleared andfalse
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 interfaceRExpirable
- Returns:
- time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.
-
remainTimeToLiveAsync
public > remainTimeToLiveAsync()
Description copied from interface:RExpirableAsync
Remaining time to live of Redisson object that has a timeout- Specified by:
remainTimeToLiveAsync
in interfaceRExpirableAsync
- Returns:
- time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.
-
expireAsync
protected > expireAsync(long timeToLive, timeUnit, ... keys)
-
expireAtAsync
protected > expireAtAsync(long timestamp, ... keys)
-
clearExpireAsync
protected > clearExpireAsync(... keys)
-
-