org.redisson

Class RedissonAtomicDouble

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonAtomicDouble

All Implemented Interfaces:

RAtomicDouble, RAtomicDoubleAsync, RExpirable, RExpirableAsync, RObject, RObjectAsync

public class RedissonAtomicDouble
extends RedissonObject
implements RAtomicDouble

Distributed alternative to the AtomicLong

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RedissonAtomicDouble(CommandAsyncExecutor commandExecutor, String name)

Method Summary

Methods

Modifier and Type	Method and Description
double	addAndGet(double delta) Atomically adds the given value to the current value.
RFuture<Double>	addAndGetAsync(double delta)
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(double expect, double update) Atomically sets the value to the given updated value only if the current value == the expected value.
RFuture<Boolean>	compareAndSetAsync(double expect, double update)
double	decrementAndGet() Atomically decrements the current value by one.
RFuture<Double>	decrementAndGetAsync()
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.
double	get() Gets the current value.
double	getAndAdd(double delta) Atomically adds the given value to the current value.
RFuture<Double>	getAndAddAsync(double delta)
double	getAndDecrement() Atomically decrements by one the current value.
RFuture<Double>	getAndDecrementAsync()
double	getAndIncrement() Atomically increments the current value by one.
RFuture<Double>	getAndIncrementAsync()
double	getAndSet(double newValue) Atomically sets the given value and returns the old value.
RFuture<Double>	getAndSetAsync(double newValue)
RFuture<Double>	getAsync()
double	incrementAndGet() Atomically increments the current value by one.
RFuture<Double>	incrementAndGetAsync()
long	remainTimeToLive() Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync() Get remaining time to live of object in seconds.
void	set(double newValue) Atomically sets the given value.
RFuture<Void>	setAsync(double newValue)
String	toString()

Methods inherited from class org.redisson.RedissonObject

await, delete, deleteAsync, encode, encodeMapKey, encodeMapValue, get, getCodec, getName, getName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, newPromise, newSucceededFuture, prefixName, rename, renameAsync, renamenx, renamenxAsync, suffixName, touch, touchAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

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

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

deleteAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, touchAsync

Constructor Detail

RedissonAtomicDouble

protected RedissonAtomicDouble(CommandAsyncExecutor commandExecutor,
                    String name)

Method Detail

addAndGet

public double addAndGet(double delta)

Description copied from interface: RAtomicDouble

Atomically adds the given value to the current value.

Specified by:

addAndGet in interface RAtomicDouble

Parameters:

delta - the value to add

Returns:

the updated value

addAndGetAsync

public RFuture<Double> addAndGetAsync(double delta)

Specified by:

addAndGetAsync in interface RAtomicDoubleAsync

compareAndSet

public boolean compareAndSet(double expect,
                    double update)

Description copied from interface: RAtomicDouble

Atomically sets the value to the given updated value only if the current value == the expected value.

Specified by:

compareAndSet in interface RAtomicDouble

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(double expect,
                                  double update)

Specified by:

compareAndSetAsync in interface RAtomicDoubleAsync

decrementAndGet

public double decrementAndGet()

Description copied from interface: RAtomicDouble

Atomically decrements the current value by one.

Specified by:

decrementAndGet in interface RAtomicDouble

Returns:

the updated value

decrementAndGetAsync

public RFuture<Double> decrementAndGetAsync()

Specified by:

decrementAndGetAsync in interface RAtomicDoubleAsync

get

public double get()

Description copied from interface: RAtomicDouble

Gets the current value.

Specified by:

get in interface RAtomicDouble

Returns:

the current value

getAsync

public RFuture<Double> getAsync()

Specified by:

getAsync in interface RAtomicDoubleAsync

getAndAdd

public double getAndAdd(double delta)

Description copied from interface: RAtomicDouble

Atomically adds the given value to the current value.

Specified by:

getAndAdd in interface RAtomicDouble

Parameters:

delta - the value to add

Returns:

the old value before the add

getAndAddAsync

public RFuture<Double> getAndAddAsync(double delta)

Specified by:

getAndAddAsync in interface RAtomicDoubleAsync

getAndSet

public double getAndSet(double newValue)

Description copied from interface: RAtomicDouble

Atomically sets the given value and returns the old value.

Specified by:

getAndSet in interface RAtomicDouble

Parameters:

newValue - the new value

Returns:

the old value

getAndSetAsync

public RFuture<Double> getAndSetAsync(double newValue)

Specified by:

getAndSetAsync in interface RAtomicDoubleAsync

incrementAndGet

public double incrementAndGet()

Description copied from interface: RAtomicDouble

Atomically increments the current value by one.

Specified by:

incrementAndGet in interface RAtomicDouble

Returns:

the updated value

incrementAndGetAsync

public RFuture<Double> incrementAndGetAsync()

Specified by:

incrementAndGetAsync in interface RAtomicDoubleAsync

getAndIncrement

public double getAndIncrement()

Description copied from interface: RAtomicDouble

Atomically increments the current value by one.

Specified by:

getAndIncrement in interface RAtomicDouble

Returns:

the old value

getAndIncrementAsync

public RFuture<Double> getAndIncrementAsync()

Specified by:

getAndIncrementAsync in interface RAtomicDoubleAsync

getAndDecrement

public double getAndDecrement()

Description copied from interface: RAtomicDouble

Atomically decrements by one the current value.

Specified by:

getAndDecrement in interface RAtomicDouble

Returns:

the previous value

getAndDecrementAsync

public RFuture<Double> getAndDecrementAsync()

Specified by:

getAndDecrementAsync in interface RAtomicDoubleAsync

set

public void set(double newValue)

Description copied from interface: RAtomicDouble

Atomically sets the given value.

Specified by:

set in interface RAtomicDouble

Parameters:

newValue - the new value

setAsync

public RFuture<Void> setAsync(double newValue)

Specified by:

setAsync in interface RAtomicDoubleAsync

toString

public String toString()

Overrides:

toString in class Object

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

Get remaining time to live of object in seconds.

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

-1 if object does not exist or time in seconds