com.hazelcast.client.impl.protocol.template

Interface CPAtomicLongCodecTemplate

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

Method Summary

Modifier and Type	Method and Description
Object	addAndGet(RaftGroupId groupId, String name, long delta) Atomically adds the given value to the current value.
void	alter(RaftGroupId groupId, String name, Data function, int returnValueType) Alters the currently stored value by applying a function on it.
Object	apply(RaftGroupId groupId, String name, Data function) Applies a function on the value, the actual stored value will not change
Object	compareAndSet(RaftGroupId groupId, String name, long expected, long updated) Atomically sets the value to the given updated value only if the current value the expected value.
Object	get(RaftGroupId groupId, String name) Gets the current value.
Object	getAndAdd(RaftGroupId groupId, String name, long delta) Atomically adds the given value to the current value.
Object	getAndSet(RaftGroupId groupId, String name, long newValue) Atomically sets the given value and returns the old value.

Method Detail

apply

Object apply(RaftGroupId groupId,
             String name,
             Data function)

Applies a function on the value, the actual stored value will not change

Parameters:

groupId - CP group id of this IAtomicLong instance.

name - Name of this IAtomicLong instance.

function - The function applied to the value and the value is not changed.

Returns:

The result of the function application.

alter

void alter(RaftGroupId groupId,
           String name,
           Data function,
           int returnValueType)

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

Parameters:

groupId - CP group id of this IAtomicLong instance.

name - Name of this IAtomicLong instance.

function - The function applied to the currently stored value.

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

addAndGet

Object addAndGet(RaftGroupId groupId,
                 String name,
                 long delta)

Atomically adds the given value to the current value.

Parameters:

groupId - CP group id of this IAtomicLong instance.

name - Name of this IAtomicLong instance.

delta - The value to add to the current value

Returns:

the updated value, the given value added to the current value

compareAndSet

Object compareAndSet(RaftGroupId groupId,
                     String name,
                     long expected,
                     long updated)

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

Parameters:

groupId - CP group id of this IAtomicLong instance.

name - Name of this IAtomicLong instance.

expected - The expected value

updated - The new value

Returns:

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

get

Object get(RaftGroupId groupId,
           String name)

Gets the current value.

Parameters:

groupId - CP group id of this IAtomicLong instance.

name - Name of this IAtomicLong instance.

Returns:

The current value

getAndAdd

Object getAndAdd(RaftGroupId groupId,
                 String name,
                 long delta)

Atomically adds the given value to the current value.

Parameters:

groupId - CP group id of this IAtomicLong instance.

name - Name of this IAtomicLong instance.

delta - The value to add to the current value

Returns:

the old value before the add

getAndSet

Object getAndSet(RaftGroupId groupId,
                 String name,
                 long newValue)

Atomically sets the given value and returns the old value.

Parameters:

groupId - CP group id of this IAtomicLong instance.

name - Name of this IAtomicLong instance.

newValue - The new value

Returns:

the old value