RaftAtomicLongProxy (Hazelcast Root 3.12-BETA-1 API)

java.lang.Object
- com.hazelcast.cp.internal.datastructures.atomiclong.proxy.RaftAtomicLongProxy

All Implemented Interfaces:

DistributedObject, IAtomicLong
```
public class RaftAtomicLongProxy
extends Object
implements IAtomicLong
```
Server-side Raft-based proxy implementation of IAtomicLong

Constructor Summary

Constructors
Constructor and Description
`RaftAtomicLongProxy(NodeEngine nodeEngine, RaftGroupId groupId, String proxyName, String objectName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`addAndGet(long delta)` Atomically adds the given value to the current value.
`InternalCompletableFuture<Long>`	`addAndGetAsync(long delta)` Atomically adds the given value to the current value.
`void`	`alter(IFunction<Long,Long> function)` Alters the currently stored value by applying a function on it.
`long`	`alterAndGet(IFunction<Long,Long> function)` Alters the currently stored value by applying a function on it and gets the result.
`InternalCompletableFuture<Long>`	`alterAndGetAsync(IFunction<Long,Long> function)` Alters the currently stored value by applying a function on it and gets the result.
`InternalCompletableFuture<Void>`	`alterAsync(IFunction<Long,Long> function)` Alters the currently stored value by applying a function on it.
`<R> R`	`apply(IFunction<Long,R> function)` Applies a function on the value, the actual stored value will not change.
`<R> InternalCompletableFuture<R>`	`applyAsync(IFunction<Long,R> function)` Applies a function on the value, the actual stored value will not change.
`boolean`	`compareAndSet(long expect, long update)` Atomically sets the value to the given updated value only if the current value `==` the expected value.
`InternalCompletableFuture<Boolean>`	`compareAndSetAsync(long expect, long update)` Atomically sets the value to the given updated value only if the current value `==` the expected value.
`long`	`decrementAndGet()` Atomically decrements the current value by one.
`InternalCompletableFuture<Long>`	`decrementAndGetAsync()` Atomically decrements the current value by one.
`void`	`destroy()` Destroys this object cluster-wide.
`long`	`get()` Gets the current value.
`long`	`getAndAdd(long delta)` Atomically adds the given value to the current value.
`InternalCompletableFuture<Long>`	`getAndAddAsync(long delta)` Atomically adds the given value to the current value.
`long`	`getAndAlter(IFunction<Long,Long> function)` Alters the currently stored value by applying a function on it on and gets the old value.
`InternalCompletableFuture<Long>`	`getAndAlterAsync(IFunction<Long,Long> function)` Alters the currently stored value by applying a function on it on and gets the old value.
`long`	`getAndIncrement()` Atomically increments the current value by one.
`InternalCompletableFuture<Long>`	`getAndIncrementAsync()` Atomically increments the current value by one.
`long`	`getAndSet(long newValue)` Atomically sets the given value and returns the old value.
`InternalCompletableFuture<Long>`	`getAndSetAsync(long newValue)` Atomically sets the given value and returns the old value.
`InternalCompletableFuture<Long>`	`getAsync()` Gets the current value.
`CPGroupId`	`getGroupId()`
`String`	`getName()` Returns the name of this IAtomicLong instance.
`String`	`getPartitionKey()` Returns the key of the partition that this DistributedObject is assigned to.
`String`	`getServiceName()` Returns the service name for this object.
`long`	`incrementAndGet()` Atomically increments the current value by one.
`InternalCompletableFuture<Long>`	`incrementAndGetAsync()` Atomically increments the current value by one.
`long`	`localGet(QueryPolicy queryPolicy)`
`ICompletableFuture<Long>`	`localGetAsync(QueryPolicy queryPolicy)`
`void`	`set(long newValue)` Atomically sets the given value.
`InternalCompletableFuture<Void>`	`setAsync(long newValue)` Atomically sets the given value.

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

- Constructor Detail
  - RaftAtomicLongProxy
```
public RaftAtomicLongProxy(NodeEngine nodeEngine,
                           RaftGroupId groupId,
                           String proxyName,
                           String objectName)
```
- Method Detail
  - addAndGet
```
public long addAndGet(long delta)
```
    Description copied from interface: IAtomicLong
    
    Atomically adds the given value to the current value.
    
    Specified by:
    
    addAndGet in interface IAtomicLong
    
    Parameters:
    
    delta - the value to add to the current value
    
    Returns:
    
    the updated value, the given value added to the current value
  - incrementAndGet
```
public long incrementAndGet()
```
    Description copied from interface: IAtomicLong
    
    Atomically increments the current value by one.
    
    Specified by:
    
    incrementAndGet in interface IAtomicLong
    
    Returns:
    
    the updated value, the current value incremented by one
  - decrementAndGet
```
public long decrementAndGet()
```
    Description copied from interface: IAtomicLong
    
    Atomically decrements the current value by one.
    
    Specified by:
    
    decrementAndGet in interface IAtomicLong
    
    Returns:
    
    the updated value, the current value decremented by one
  - compareAndSet
```
public boolean compareAndSet(long expect,
                             long update)
```
    Description copied from interface: IAtomicLong
    
    Atomically sets the value to the given updated value only if the current value == the expected value.
    
    Specified by:
    
    compareAndSet in interface IAtomicLong
    
    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.
  - getAndAdd
```
public long getAndAdd(long delta)
```
    Description copied from interface: IAtomicLong
    
    Atomically adds the given value to the current value.
    
    Specified by:
    
    getAndAdd in interface IAtomicLong
    
    Parameters:
    
    delta - the value to add to the current value
    
    Returns:
    
    the old value before the add
  - get
```
public long get()
```
    Description copied from interface: IAtomicLong
    
    Gets the current value.
    
    Specified by:
    
    get in interface IAtomicLong
    
    Returns:
    
    the current value
  - getAndIncrement
```
public long getAndIncrement()
```
    Description copied from interface: IAtomicLong
    
    Atomically increments the current value by one.
    
    Specified by:
    
    getAndIncrement in interface IAtomicLong
    
    Returns:
    
    the old value
  - getAndSet
```
public long getAndSet(long newValue)
```
    Description copied from interface: IAtomicLong
    
    Atomically sets the given value and returns the old value.
    
    Specified by:
    
    getAndSet in interface IAtomicLong
    
    Parameters:
    
    newValue - the new value
    
    Returns:
    
    the old value
  - set
```
public void set(long newValue)
```
    Description copied from interface: IAtomicLong
    
    Atomically sets the given value.
    
    Specified by:
    
    set in interface IAtomicLong
    
    Parameters:
    
    newValue - the new value
  - addAndGetAsync
```
public InternalCompletableFuture<Long> addAndGetAsync(long delta)
```
    Description copied from interface: IAtomicLong
    Atomically adds the given value to the current value.
    This method will dispatch a request and return immediately an ICompletableFuture.
    The operations result can be obtained in a blocking way, or a callback can be provided for execution upon completion, as demonstrated in the following examples:
```
 ICompletableFuture future = atomicLong.addAndGetAsync(13);
 // do something else, then read the result

 // this method will block until the result is available
 Long result = future.get();
 
```
```
 ICompletableFuture future = atomicLong.addAndGetAsync(13);
 future.andThen(new ExecutionCallback<Long>() {
     void onResponse(Long response) {
         // do something with the result
     }

     void onFailure(Throwable t) {
         // handle failure
     }
 });
 
```
    Specified by:
    
    addAndGetAsync in interface IAtomicLong
    
    Parameters:
    
    delta - the value to add
    
    Returns:
    
    an ICompletableFuture bearing the response
  - incrementAndGetAsync
```
public InternalCompletableFuture<Long> incrementAndGetAsync()
```
    Description copied from interface: IAtomicLong
    
    Atomically increments the current value by one.
    This method will dispatch a request and return immediately an ICompletableFuture.
    
    Specified by:
    
    incrementAndGetAsync in interface IAtomicLong
    
    Returns:
    
    an ICompletableFuture with the updated value
  - decrementAndGetAsync
```
public InternalCompletableFuture<Long> decrementAndGetAsync()
```
    Description copied from interface: IAtomicLong
    
    Atomically decrements the current value by one.
    This method will dispatch a request and return immediately an ICompletableFuture.
    
    Specified by:
    
    decrementAndGetAsync in interface IAtomicLong
    
    Returns:
    
    an ICompletableFuture with the updated value
  - compareAndSetAsync
```
public InternalCompletableFuture<Boolean> compareAndSetAsync(long expect,
                                                             long update)
```
    Description copied from interface: IAtomicLong
    
    Atomically sets the value to the given updated value only if the current value == the expected value.
    This method will dispatch a request and return immediately an ICompletableFuture.
    
    Specified by:
    
    compareAndSetAsync in interface IAtomicLong
    
    Parameters:
    
    expect - the expected value
    
    update - the new value
    
    Returns:
    
    an ICompletableFuture with value true if successful; or false if the actual value was not equal to the expected value
  - getAndAddAsync
```
public InternalCompletableFuture<Long> getAndAddAsync(long delta)
```
    Description copied from interface: IAtomicLong
    
    Atomically adds the given value to the current value.
    This method will dispatch a request and return immediately an ICompletableFuture.
    
    Specified by:
    
    getAndAddAsync in interface IAtomicLong
    
    Parameters:
    
    delta - the value to add
    
    Returns:
    
    an ICompletableFuture with the old value before the addition
  - getAsync
```
public InternalCompletableFuture<Long> getAsync()
```
    Description copied from interface: IAtomicLong
    
    Gets the current value. This method will dispatch a request and return immediately an ICompletableFuture.
    
    Specified by:
    
    getAsync in interface IAtomicLong
    
    Returns:
    
    an ICompletableFuture with the current value
  - getAndIncrementAsync
```
public InternalCompletableFuture<Long> getAndIncrementAsync()
```
    Description copied from interface: IAtomicLong
    
    Atomically increments the current value by one.
    This method will dispatch a request and return immediately an ICompletableFuture.
    
    Specified by:
    
    getAndIncrementAsync in interface IAtomicLong
    
    Returns:
    
    an ICompletableFuture with the old value
  - getAndSetAsync
```
public InternalCompletableFuture<Long> getAndSetAsync(long newValue)
```
    Description copied from interface: IAtomicLong
    
    Atomically sets the given value and returns the old value.
    This method will dispatch a request and return immediately an ICompletableFuture.
    
    Specified by:
    
    getAndSetAsync in interface IAtomicLong
    
    Parameters:
    
    newValue - the new value
    
    Returns:
    
    an ICompletableFuture with the old value
  - setAsync
```
public InternalCompletableFuture<Void> setAsync(long newValue)
```
    Description copied from interface: IAtomicLong
    
    Atomically sets the given value.
    This method will dispatch a request and return immediately an ICompletableFuture.
    
    Specified by:
    
    setAsync in interface IAtomicLong
    
    Parameters:
    
    newValue - the new value
    
    Returns:
    
    an ICompletableFuture
  - alter
```
public void alter(IFunction<Long,Long> function)
```
    Description copied from interface: IAtomicLong
    
    Alters the currently stored value by applying a function on it.
    
    Specified by:
    
    alter in interface IAtomicLong
    
    Parameters:
    
    function - the function applied to the currently stored value
  - alterAndGet
```
public long alterAndGet(IFunction<Long,Long> function)
```
    Description copied from interface: IAtomicLong
    
    Alters the currently stored value by applying a function on it and gets the result.
    
    Specified by:
    
    alterAndGet in interface IAtomicLong
    
    Parameters:
    
    function - the function applied to the currently stored value
    
    Returns:
    
    the new value
  - getAndAlter
```
public long getAndAlter(IFunction<Long,Long> function)
```
    Description copied from interface: IAtomicLong
    
    Alters the currently stored value by applying a function on it on and gets the old value.
    
    Specified by:
    
    getAndAlter in interface IAtomicLong
    
    Parameters:
    
    function - the function applied to the currently stored value
    
    Returns:
    
    the old value
  - apply
```
public <R> R apply(IFunction<Long,R> function)
```
    Description copied from interface: IAtomicLong
    
    Applies a function on the value, the actual stored value will not change.
    
    Specified by:
    
    apply in interface IAtomicLong
    
    Parameters:
    
    function - the function applied to the value, the value is not changed
    
    Returns:
    
    the result of the function application
  - alterAsync
```
public InternalCompletableFuture<Void> alterAsync(IFunction<Long,Long> function)
```
    Description copied from interface: IAtomicLong
    
    Alters the currently stored value by applying a function on it.
    This method will dispatch a request and return immediately an ICompletableFuture.
    
    Specified by:
    
    alterAsync in interface IAtomicLong
    
    Parameters:
    
    function - the function
    
    Returns:
    
    an ICompletableFuture with the new value
  - alterAndGetAsync
```
public InternalCompletableFuture<Long> alterAndGetAsync(IFunction<Long,Long> function)
```
    Description copied from interface: IAtomicLong
    
    Alters the currently stored value by applying a function on it and gets the result.
    This method will dispatch a request and return immediately an ICompletableFuture.
    
    Specified by:
    
    alterAndGetAsync in interface IAtomicLong
    
    Parameters:
    
    function - the function
    
    Returns:
    
    an ICompletableFuture with the new value
  - getAndAlterAsync
```
public InternalCompletableFuture<Long> getAndAlterAsync(IFunction<Long,Long> function)
```
    Description copied from interface: IAtomicLong
    
    Alters the currently stored value by applying a function on it on and gets the old value.
    This method will dispatch a request and return immediately an ICompletableFuture.
    
    Specified by:
    
    getAndAlterAsync in interface IAtomicLong
    
    Parameters:
    
    function - the function
    
    Returns:
    
    an ICompletableFuture with the old value
  - applyAsync
```
public <R> InternalCompletableFuture<R> applyAsync(IFunction<Long,R> function)
```
    Description copied from interface: IAtomicLong
    Applies a function on the value, the actual stored value will not change.
    This method will dispatch a request and return immediately an ICompletableFuture. For example:
```
 class IsOneFunction implements IFunction {
     @Override
     public Boolean apply(Long input) {
         return input.equals(1L);
     }
 }

 ICompletableFuture future = atomicLong.applyAsync(new IsOneFunction());
 future.andThen(new ExecutionCallback<;Boolean>() {
    void onResponse(Boolean response) {
        // do something with the response
    }

    void onFailure(Throwable t) {
       // handle failure
    }
 });
 
```
    Specified by:
    
    applyAsync in interface IAtomicLong
    
    Parameters:
    
    function - the function
    
    Returns:
    
    an ICompletableFuture with the result of the function application
  - localGet
```
public long localGet(QueryPolicy queryPolicy)
```
  - localGetAsync
```
public ICompletableFuture<Long> localGetAsync(QueryPolicy queryPolicy)
```
  - getPartitionKey
```
public String getPartitionKey()
```
    Description copied from interface: DistributedObject
    
    Returns the key of the partition that this DistributedObject is assigned to. The returned value only has meaning for a non-partitioned data structure like an IAtomicLong. For a partitioned data structure like an IMap, the returned value will not be null, but otherwise undefined.
    
    Specified by:
    
    getPartitionKey in interface DistributedObject
    
    Returns:
    
    the partition key.
  - getName
```
public String getName()
```
    Description copied from interface: IAtomicLong
    
    Returns the name of this IAtomicLong instance.
    
    Specified by:
    
    getName in interface DistributedObject
    
    Specified by:
    
    getName in interface IAtomicLong
    
    Returns:
    
    the name of this IAtomicLong instance
  - getServiceName
```
public String getServiceName()
```
    Description copied from interface: DistributedObject
    
    Returns the service name for this object.
    
    Specified by:
    
    getServiceName in interface DistributedObject
    
    Returns:
    
    the service name for this object.
  - destroy
```
public void destroy()
```
    Description copied from interface: DistributedObject
    
    Destroys this object cluster-wide. Clears and releases all resources for this object.
    
    Specified by:
    
    destroy in interface DistributedObject
  - getGroupId
```
public CPGroupId getGroupId()
```

Class RaftAtomicLongProxy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RaftAtomicLongProxy

Method Detail

addAndGet

incrementAndGet

decrementAndGet

compareAndSet

getAndAdd

get

getAndIncrement

getAndSet

set

addAndGetAsync

incrementAndGetAsync

decrementAndGetAsync

compareAndSetAsync

getAndAddAsync

getAsync

getAndIncrementAsync

getAndSetAsync

setAsync

alter

alterAndGet

getAndAlter

apply

alterAsync

alterAndGetAsync

getAndAlterAsync

applyAsync

localGet

localGetAsync

getPartitionKey

getName

getServiceName

destroy

getGroupId