RedisAtomicDouble (Spring Data Redis 2.0.14.RELEASE API)

java.lang.Object
- java.lang.Number
- - org.springframework.data.redis.support.atomic.RedisAtomicDouble

All Implemented Interfaces:

Serializable, BoundKeyOperations<String>
```
public class RedisAtomicDouble
extends Number
implements Serializable, BoundKeyOperations<String>
```
Atomic double backed by Redis. Uses Redis atomic increment/decrement and watch/multi/exec operations for CAS operations.

Author:

Jennifer Hickey, Thomas Darimont, Christoph Strobl, Mark Paluch, Ning Wei

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`RedisAtomicDouble(String redisCounter, RedisConnectionFactory factory)` Constructs a new `RedisAtomicDouble` instance.
`RedisAtomicDouble(String redisCounter, RedisConnectionFactory factory, double initialValue)` Constructs a new `RedisAtomicDouble` instance.
`RedisAtomicDouble(String redisCounter, RedisOperations<String,Double> template)` Constructs a new `RedisAtomicDouble` instance.
`RedisAtomicDouble(String redisCounter, RedisOperations<String,Double> template, double initialValue)` Constructs a new `RedisAtomicDouble` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`addAndGet(double delta)` Atomically add the given value to current value.
`boolean`	`compareAndSet(double expect, double update)` Atomically set the value to the given updated value if the current value `==` the expected value.
`double`	`decrementAndGet()` Atomically decrement by one the current value.
`double`	`doubleValue()`
`Boolean`	`expire(long timeout, TimeUnit unit)` Sets the key time-to-live/expiration.
`Boolean`	`expireAt(Date date)` Sets the key time-to-live/expiration.
`float`	`floatValue()`
`double`	`get()` Get the current value.
`double`	`getAndAdd(double delta)` Atomically add the given value to current value.
`double`	`getAndDecrement()` Atomically decrement by one the current value.
`double`	`getAndIncrement()` Atomically increment by one the current value.
`double`	`getAndSet(double newValue)` Set to the given value and return the old value.
`Long`	`getExpire()` Returns the expiration of this key.
`String`	`getKey()` Returns the key associated with this entity.
`DataType`	`getType()` Returns the associated Redis type.
`double`	`incrementAndGet()` Atomically increment by one the current value.
`int`	`intValue()`
`long`	`longValue()`
`Boolean`	`persist()` Removes the expiration (if any) of the key.
`void`	`rename(String newKey)` Renames the key.
`void`	`set(double newValue)` Set to the given value.
`String`	`toString()`

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RedisAtomicDouble
```
public RedisAtomicDouble(String redisCounter,
                         RedisConnectionFactory factory)
```
    Constructs a new RedisAtomicDouble instance. Uses the value existing in Redis or 0 if none is found.
    
    Parameters:
    
    redisCounter - Redis key of this counter.
    
    factory - connection factory.
  - RedisAtomicDouble
```
public RedisAtomicDouble(String redisCounter,
                         RedisConnectionFactory factory,
                         double initialValue)
```
    Constructs a new RedisAtomicDouble instance.
    
    Parameters:
    
    redisCounter - Redis key of this counter.
    
    factory - connection factory.
    
    initialValue - initial value to set if the Redis key is absent.
  - RedisAtomicDouble
```
public RedisAtomicDouble(String redisCounter,
                         RedisOperations<String,Double> template)
```
    Constructs a new RedisAtomicDouble instance. Uses the value existing in Redis or 0 if none is found.
    
    Parameters:
    
    redisCounter - Redis key of this counter.
    
    template - the template.
    
    See Also:
    
    RedisAtomicDouble(String, RedisConnectionFactory, double)
  - RedisAtomicDouble
```
public RedisAtomicDouble(String redisCounter,
                         RedisOperations<String,Double> template,
                         double initialValue)
```
    Constructs a new RedisAtomicDouble instance. Note: You need to configure the given template with appropriate RedisSerializer for the key and value. As an alternative one could use the RedisAtomicDouble(String, RedisConnectionFactory, Double) constructor which uses appropriate default serializers.
    
    Parameters:
    
    redisCounter - Redis key of this counter.
    
    template - the template
    
    initialValue - initial value to set if the Redis key is absent.
- Method Detail
  - get
```
public double get()
```
    Get the current value.
    
    Returns:
    
    the current value.
  - set
```
public void set(double newValue)
```
    Set to the given value.
    
    Parameters:
    
    newValue - the new value.
  - getAndSet
```
public double getAndSet(double newValue)
```
    Set to the given value and return the old value.
    
    Parameters:
    
    newValue - the new value.
    
    Returns:
    
    the previous value.
  - compareAndSet
```
public boolean compareAndSet(double expect,
                             double update)
```
    Atomically set the value to the given updated value if the current value == the expected value.
    
    Parameters:
    
    expect - the expected value.
    
    update - the new value.
    
    Returns:
    
    true if successful. false indicates that the actual value was not equal to the expected value.
  - getAndIncrement
```
public double getAndIncrement()
```
    Atomically increment by one the current value.
    
    Returns:
    
    the previous value.
  - getAndDecrement
```
public double getAndDecrement()
```
    Atomically decrement by one the current value.
    
    Returns:
    
    the previous value.
  - getAndAdd
```
public double getAndAdd(double delta)
```
    Atomically add the given value to current value.
    
    Parameters:
    
    delta - the value to add.
    
    Returns:
    
    the previous value.
  - incrementAndGet
```
public double incrementAndGet()
```
    Atomically increment by one the current value.
    
    Returns:
    
    the updated value.
  - decrementAndGet
```
public double decrementAndGet()
```
    Atomically decrement by one the current value.
    
    Returns:
    
    the updated value.
  - addAndGet
```
public double addAndGet(double delta)
```
    Atomically add the given value to current value.
    
    Parameters:
    
    delta - the value to add.
    
    Returns:
    
    the updated value.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the String representation of the current value.
  - getKey
```
public String getKey()
```
    Description copied from interface: BoundKeyOperations
    
    Returns the key associated with this entity.
    
    Specified by:
    
    getKey in interface BoundKeyOperations<String>
    
    Returns:
    
    key associated with the implementing entity
  - getType
```
public DataType getType()
```
    Description copied from interface: BoundKeyOperations
    
    Returns the associated Redis type.
    
    Specified by:
    
    getType in interface BoundKeyOperations<String>
    
    Returns:
    
    key type. null when used in pipeline / transaction.
  - getExpire
```
public Long getExpire()
```
    Description copied from interface: BoundKeyOperations
    
    Returns the expiration of this key.
    
    Specified by:
    
    getExpire in interface BoundKeyOperations<String>
    
    Returns:
    
    expiration value (in seconds). null when used in pipeline / transaction.
  - expire
```
public Boolean expire(long timeout,
                      TimeUnit unit)
```
    Description copied from interface: BoundKeyOperations
    
    Sets the key time-to-live/expiration.
    
    Specified by:
    
    expire in interface BoundKeyOperations<String>
    
    Parameters:
    
    timeout - expiration value
    
    unit - expiration unit
    
    Returns:
    
    true if expiration was set, false otherwise. null when used in pipeline / transaction.
  - expireAt
```
public Boolean expireAt(Date date)
```
    Description copied from interface: BoundKeyOperations
    
    Sets the key time-to-live/expiration.
    
    Specified by:
    
    expireAt in interface BoundKeyOperations<String>
    
    Parameters:
    
    date - expiration date
    
    Returns:
    
    true if expiration was set, false otherwise. null when used in pipeline / transaction.
  - persist
```
public Boolean persist()
```
    Description copied from interface: BoundKeyOperations
    
    Removes the expiration (if any) of the key.
    
    Specified by:
    
    persist in interface BoundKeyOperations<String>
    
    Returns:
    
    true if expiration was removed, false otherwise. null when used in pipeline / transaction.
  - rename
```
public void rename(String newKey)
```
    Description copied from interface: BoundKeyOperations
    
    Renames the key.
    Note: The new name for empty collections will be propagated on add of first element.
    
    Specified by:
    
    rename in interface BoundKeyOperations<String>
    
    Parameters:
    
    newKey - new key. Must not be null.
  - intValue
```
public int intValue()
```
    Specified by:
    
    intValue in class Number
  - longValue
```
public long longValue()
```
    Specified by:
    
    longValue in class Number
  - floatValue
```
public float floatValue()
```
    Specified by:
    
    floatValue in class Number
  - doubleValue
```
public double doubleValue()
```
    Specified by:
    
    doubleValue in class Number

Class RedisAtomicDouble

Constructor Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Constructor Detail

RedisAtomicDouble

RedisAtomicDouble

RedisAtomicDouble

RedisAtomicDouble

Method Detail

get

set

getAndSet

compareAndSet

getAndIncrement

getAndDecrement

getAndAdd

incrementAndGet

decrementAndGet

addAndGet

toString

getKey

getType

getExpire

expire

expireAt

persist

rename

intValue

longValue

floatValue

doubleValue