com.hazelcast.client.impl.protocol.template

Interface CPAtomicRefCodecTemplate

@Since(value="1.8")
public interface CPAtomicRefCodecTemplate

Method Summary

Modifier and Type	Method and Description
Object	apply(RaftGroupId groupId, String name, Data function, int returnValueType, boolean alter) Applies a function on the value
Object	compareAndSet(RaftGroupId groupId, String name, Data oldValue, Data newValue) Alters the currently stored value by applying a function on it.
Object	contains(RaftGroupId groupId, String name, Data value) Checks if the reference contains the value.
Object	get(RaftGroupId groupId, String name) Gets the current value.
Object	set(RaftGroupId groupId, String name, Data newValue, boolean returnOldValue) Atomically sets the given value

Method Detail

apply

Object apply(RaftGroupId groupId,
             String name,
             Data function,
             int returnValueType,
             boolean alter)

Applies a function on the value

Parameters:

groupId - CP group id of this IAtomicReference instance.

name - The name of this IAtomicReference instance.

function - The function applied to the value.

returnValueType - 0 returns no value, 1 returns the old value, 2 returns the new value

alter - Denotes whether result of the function will be set to the IAtomicRefInstance

Returns:

The result of the function application.

compareAndSet

Object compareAndSet(RaftGroupId groupId,
                     String name,
                     @Nullable
                     Data oldValue,
                     @Nullable
                     Data newValue)

Alters the currently stored value by applying a function on it.

Parameters:

groupId - CP group id of this IAtomicReference instance.

name - Name of this IAtomicReference instance.

oldValue - The expected value

newValue - The new value

Returns:

true if successful; or false if the actual value was not equal to the expected value.

contains

Object contains(RaftGroupId groupId,
                String name,
                @Nullable
                Data value)

Checks if the reference contains the value.

Parameters:

groupId - CP group id of this IAtomicReference instance.

name - Name of this IAtomicReference instance.

value - The value to check (is allowed to be null).

Returns:

true if the value is found, false otherwise.

get

Object get(RaftGroupId groupId,
           String name)

Gets the current value.

Parameters:

groupId - CP group id of this IAtomicReference instance.

name - Name of this IAtomicReference instance.

Returns:

The current value

set

Object set(RaftGroupId groupId,
           String name,
           @Nullable
           Data newValue,
           boolean returnOldValue)

Atomically sets the given value

Parameters:

groupId - CP group id of this IAtomicReference instance.

name - Name of this IAtomicReference instance.

newValue - The value to set

returnOldValue - Denotes whether the old value is returned or not

Returns:

the old value or null, depending on the returnOldValue parameter