org.redisson

Class RedissonBaseAdder<T extends Number>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonBaseAdder<T>

All Implemented Interfaces:

RExpirable, RExpirableAsync, RObject, RObjectAsync

Direct Known Subclasses:

RedissonDoubleAdder, RedissonLongAdder

public abstract class RedissonBaseAdder<T extends Number>
extends RedissonObject

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor

Constructor Summary

Constructors

Constructor and Description
RedissonBaseAdder(CommandAsyncExecutor connectionManager, String name, RedissonClient redisson)

Method Summary

Modifier and Type	Method and Description
protected abstract RFuture<T>	addAndGetAsync()
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.
void	destroy()
protected abstract void	doReset()
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.
protected abstract RFuture<T>	getAndDeleteAsync()
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	reset()
void	reset(long timeout, TimeUnit timeUnit)
RFuture<Void>	resetAsync()
RFuture<Void>	resetAsync(long timeout, TimeUnit timeUnit)
RFuture<T>	sumAsync()
RFuture<T>	sumAsync(long timeout, TimeUnit timeUnit)
protected RFuture<Void>	tryAcquire(long timeout, TimeUnit timeUnit, int value)

Methods inherited from class org.redisson.RedissonObject

addListener, addListenerAsync, await, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getLockByMapKey, getLockByValue, getName, getName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, removeListener, removeListenerAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, 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.RObject

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

Methods inherited from interface org.redisson.api.RObjectAsync

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

Constructor Detail

RedissonBaseAdder

public RedissonBaseAdder(CommandAsyncExecutor connectionManager,
                         String name,
                         RedissonClient redisson)

Method Detail

doReset

protected abstract void doReset()

reset

public void reset()

reset

public void reset(long timeout,
                  TimeUnit timeUnit)

sumAsync

public RFuture<T> sumAsync()

sumAsync

public RFuture<T> sumAsync(long timeout,
                           TimeUnit timeUnit)

tryAcquire

protected RFuture<Void> tryAcquire(long timeout,
                                   TimeUnit timeUnit,
                                   int value)

resetAsync

public RFuture<Void> resetAsync()

resetAsync

public RFuture<Void> resetAsync(long timeout,
                                TimeUnit timeUnit)

destroy

public void destroy()

addAndGetAsync

protected abstract RFuture<T> addAndGetAsync()

getAndDeleteAsync

protected abstract RFuture<T> getAndDeleteAsync()

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.