AtomicRefProxy (Hazelcast Root 4.0-BETA-1 API)

java.lang.Object
- com.hazelcast.client.impl.spi.ClientProxy
- - com.hazelcast.client.cp.internal.datastructures.atomicref.AtomicRefProxy<T>

Type Parameters:

T - the type of object referred to by this reference

All Implemented Interfaces:

DistributedObject, IAtomicReference<T>
```
public class AtomicRefProxy<T>
extends ClientProxy
implements IAtomicReference<T>
```
Client-side Raft-based proxy implementation of IAtomicReference

Field Summary
- Fields inherited from class com.hazelcast.client.impl.spi.ClientProxy
  name

Constructor Summary

Constructors
Constructor and Description

AtomicRefProxy(ClientContext context, RaftGroupId groupId, String proxyName, String objectName)

Constructors
Constructor and Description
`AtomicRefProxy(ClientContext context, RaftGroupId groupId, String proxyName, String objectName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`alter(IFunction<T,T> function)` Alters the currently stored reference by applying a function on it.
`T`	`alterAndGet(IFunction<T,T> function)` Alters the currently stored reference by applying a function on it and gets the result.
`InternalCompletableFuture<T>`	`alterAndGetAsync(IFunction<T,T> function)` Alters the currently stored reference by applying a function on it and gets the result.
`InternalCompletableFuture<Void>`	`alterAsync(IFunction<T,T> function)` Alters the currently stored reference by applying a function on it.
`<R> R`	`apply(IFunction<T,R> function)` Applies a function on the value, the actual stored value will not change.
`<R> InternalCompletableFuture<R>`	`applyAsync(IFunction<T,R> function)` Applies a function on the value, the actual stored value will not change.
`void`	`clear()` Clears the current stored reference.
`InternalCompletableFuture<Void>`	`clearAsync()` Clears the current stored reference.
`boolean`	`compareAndSet(T expect, T update)` Atomically sets the value to the given updated value only if the current value `==` the expected value.
`InternalCompletableFuture<Boolean>`	`compareAndSetAsync(T expect, T update)` Atomically sets the value to the given updated value only if the current value `==` the expected value.
`boolean`	`contains(T value)` Checks if the reference contains the value.
`InternalCompletableFuture<Boolean>`	`containsAsync(T expected)` Checks if the reference contains the value.
`T`	`get()` Gets the current value.
`T`	`getAndAlter(IFunction<T,T> function)` Alters the currently stored reference by applying a function on it on and gets the old value.
`InternalCompletableFuture<T>`	`getAndAlterAsync(IFunction<T,T> function)` Alters the currently stored reference by applying a function on it on and gets the old value.
`T`	`getAndSet(T newValue)` Gets the old value and sets the new value.
`InternalCompletableFuture<T>`	`getAndSetAsync(T newValue)` Gets the value and sets the new value.
`InternalCompletableFuture<T>`	`getAsync()` Gets the current value.
`CPGroupId`	`getGroupId()`
`String`	`getPartitionKey()` Returns the key of the partition that this DistributedObject is assigned to.
`boolean`	`isNull()` Checks if the stored reference is `null`.
`InternalCompletableFuture<Boolean>`	`isNullAsync()` Checks if the stored reference is `null`.
`void`	`onDestroy()` Called before proxy is destroyed.
`void`	`set(T newValue)` Atomically sets the given value.
`InternalCompletableFuture<Void>`	`setAsync(T newValue)` Atomically sets the given value.

Methods inherited from class com.hazelcast.client.impl.spi.ClientProxy
deregisterListener, destroy, destroyLocally, destroyRemotely, equals, getClient, getContext, getDistributedObjectName, getId, getName, getSerializationService, getServiceName, hashCode, invoke, invoke, invokeOnAddress, invokeOnPartition, invokeOnPartitionInterruptibly, onInitialize, onShutdown, postDestroy, preDestroy, registerListener, toData, toObject

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

Methods inherited from interface com.hazelcast.core.DistributedObject
destroy, getName, getServiceName

- Constructor Detail
  - AtomicRefProxy
```
public AtomicRefProxy(ClientContext context,
                      RaftGroupId groupId,
                      String proxyName,
                      String objectName)
```
- Method Detail
  - compareAndSet
```
public boolean compareAndSet(T expect,
                             T update)
```
    Description copied from interface: IAtomicReference
    
    Atomically sets the value to the given updated value only if the current value == the expected value.
    
    Specified by:
    
    compareAndSet in interface IAtomicReference<T>
    
    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
  - get
```
public T get()
```
    Description copied from interface: IAtomicReference
    
    Gets the current value.
    
    Specified by:
    
    get in interface IAtomicReference<T>
    
    Returns:
    
    the current value
  - set
```
public void set(T newValue)
```
    Description copied from interface: IAtomicReference
    
    Atomically sets the given value.
    
    Specified by:
    
    set in interface IAtomicReference<T>
    
    Parameters:
    
    newValue - the new value
  - getAndSet
```
public T getAndSet(T newValue)
```
    Description copied from interface: IAtomicReference
    
    Gets the old value and sets the new value.
    
    Specified by:
    
    getAndSet in interface IAtomicReference<T>
    
    Parameters:
    
    newValue - the new value
    
    Returns:
    
    the old value
  - isNull
```
public boolean isNull()
```
    Description copied from interface: IAtomicReference
    
    Checks if the stored reference is null.
    
    Specified by:
    
    isNull in interface IAtomicReference<T>
    
    Returns:
    
    true if null, false otherwise
  - clear
```
public void clear()
```
    Description copied from interface: IAtomicReference
    
    Clears the current stored reference.
    
    Specified by:
    
    clear in interface IAtomicReference<T>
  - contains
```
public boolean contains(T value)
```
    Description copied from interface: IAtomicReference
    
    Checks if the reference contains the value.
    
    Specified by:
    
    contains in interface IAtomicReference<T>
    
    Parameters:
    
    value - the value to check (is allowed to be null)
    
    Returns:
    
    true if the value is found, false otherwise
  - alter
```
public void alter(IFunction<T,T> function)
```
    Description copied from interface: IAtomicReference
    
    Alters the currently stored reference by applying a function on it.
    
    Specified by:
    
    alter in interface IAtomicReference<T>
    
    Parameters:
    
    function - the function that alters the currently stored reference
  - alterAndGet
```
public T alterAndGet(IFunction<T,T> function)
```
    Description copied from interface: IAtomicReference
    
    Alters the currently stored reference by applying a function on it and gets the result.
    
    Specified by:
    
    alterAndGet in interface IAtomicReference<T>
    
    Parameters:
    
    function - the function that alters the currently stored reference
    
    Returns:
    
    the new value, the result of the applied function
  - getAndAlter
```
public T getAndAlter(IFunction<T,T> function)
```
    Description copied from interface: IAtomicReference
    
    Alters the currently stored reference by applying a function on it on and gets the old value.
    
    Specified by:
    
    getAndAlter in interface IAtomicReference<T>
    
    Parameters:
    
    function - the function that alters the currently stored reference
    
    Returns:
    
    the old value, the value before the function is applied
  - apply
```
public <R> R apply(IFunction<T,R> function)
```
    Description copied from interface: IAtomicReference
    
    Applies a function on the value, the actual stored value will not change.
    
    Specified by:
    
    apply in interface IAtomicReference<T>
    
    Parameters:
    
    function - the function applied on the value, the stored value does not change
    
    Returns:
    
    the result of the function application
  - compareAndSetAsync
```
public InternalCompletableFuture<Boolean> compareAndSetAsync(T expect,
                                                             T update)
```
    Description copied from interface: IAtomicReference
    
    Atomically sets the value to the given updated value only if the current value == the expected value.
    
    Specified by:
    
    compareAndSetAsync in interface IAtomicReference<T>
    
    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
  - getAsync
```
public InternalCompletableFuture<T> getAsync()
```
    Description copied from interface: IAtomicReference
    
    Gets the current value.
    
    Specified by:
    
    getAsync in interface IAtomicReference<T>
    
    Returns:
    
    the current value
  - setAsync
```
public InternalCompletableFuture<Void> setAsync(T newValue)
```
    Description copied from interface: IAtomicReference
    
    Atomically sets the given value.
    
    Specified by:
    
    setAsync in interface IAtomicReference<T>
    
    Parameters:
    
    newValue - the new value
  - getAndSetAsync
```
public InternalCompletableFuture<T> getAndSetAsync(T newValue)
```
    Description copied from interface: IAtomicReference
    
    Gets the value and sets the new value.
    
    Specified by:
    
    getAndSetAsync in interface IAtomicReference<T>
    
    Parameters:
    
    newValue - the new value
    
    Returns:
    
    the old value
  - isNullAsync
```
public InternalCompletableFuture<Boolean> isNullAsync()
```
    Description copied from interface: IAtomicReference
    
    Checks if the stored reference is null.
    
    Specified by:
    
    isNullAsync in interface IAtomicReference<T>
    
    Returns:
    
    true if null, false otherwise
  - clearAsync
```
public InternalCompletableFuture<Void> clearAsync()
```
    Description copied from interface: IAtomicReference
    
    Clears the current stored reference.
    
    Specified by:
    
    clearAsync in interface IAtomicReference<T>
  - containsAsync
```
public InternalCompletableFuture<Boolean> containsAsync(T expected)
```
    Description copied from interface: IAtomicReference
    
    Checks if the reference contains the value.
    
    Specified by:
    
    containsAsync in interface IAtomicReference<T>
    
    Parameters:
    
    expected - the value to check (is allowed to be null)
    
    Returns:
    
    true if the value is found, false otherwise
  - alterAsync
```
public InternalCompletableFuture<Void> alterAsync(IFunction<T,T> function)
```
    Description copied from interface: IAtomicReference
    
    Alters the currently stored reference by applying a function on it.
    
    Specified by:
    
    alterAsync in interface IAtomicReference<T>
    
    Parameters:
    
    function - the function
  - alterAndGetAsync
```
public InternalCompletableFuture<T> alterAndGetAsync(IFunction<T,T> function)
```
    Description copied from interface: IAtomicReference
    
    Alters the currently stored reference by applying a function on it and gets the result.
    
    Specified by:
    
    alterAndGetAsync in interface IAtomicReference<T>
    
    Parameters:
    
    function - the function
    
    Returns:
    
    the new value
  - getAndAlterAsync
```
public InternalCompletableFuture<T> getAndAlterAsync(IFunction<T,T> function)
```
    Description copied from interface: IAtomicReference
    
    Alters the currently stored reference by applying a function on it on and gets the old value.
    
    Specified by:
    
    getAndAlterAsync in interface IAtomicReference<T>
    
    Parameters:
    
    function - the function
    
    Returns:
    
    the old value
  - applyAsync
```
public <R> InternalCompletableFuture<R> applyAsync(IFunction<T,R> function)
```
    Description copied from interface: IAtomicReference
    
    Applies a function on the value, the actual stored value will not change.
    
    Specified by:
    
    applyAsync in interface IAtomicReference<T>
    
    Parameters:
    
    function - the function
    
    Returns:
    
    the result of the function application
  - onDestroy
```
public void onDestroy()
```
    Description copied from class: ClientProxy
    
    Called before proxy is destroyed. Overriding implementations should clean/release resources created during initialization.
    
    Overrides:
    
    onDestroy in class ClientProxy
  - 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
    
    Overrides:
    
    getPartitionKey in class ClientProxy
    
    Returns:
    
    the partition key.
  - getGroupId
```
public CPGroupId getGroupId()
```

Class AtomicRefProxy<T>

Field Summary

Fields inherited from class com.hazelcast.client.impl.spi.ClientProxy

Constructor Summary

Method Summary

Methods inherited from class com.hazelcast.client.impl.spi.ClientProxy

Methods inherited from class java.lang.Object

Methods inherited from interface com.hazelcast.core.DistributedObject

Constructor Detail

AtomicRefProxy

Method Detail

compareAndSet

get

set

getAndSet

isNull

clear

contains

alter

alterAndGet

getAndAlter

apply

compareAndSetAsync

getAsync

setAsync

getAndSetAsync

isNullAsync

clearAsync

containsAsync

alterAsync

alterAndGetAsync

getAndAlterAsync

applyAsync

onDestroy

getPartitionKey

getGroupId