com.hazelcast.client.impl.protocol.template

Interface AtomicReferenceCodecTemplate

public interface AtomicReferenceCodecTemplate

Method Summary

Methods

Modifier and Type	Method and Description
void	alter(String name, Data function) Alters the currently stored reference by applying a function on it.
Object	alterAndGet(String name, Data function) Alters the currently stored reference by applying a function on it and gets the result.
Object	apply(String name, Data function) Applies a function on the value, the actual stored value will not change.
void	clear(String name) Clears the current stored reference.
Object	compareAndSet(String name, Data expected, Data updated) Atomically sets the value to the given updated value only if the current value the expected value.
Object	contains(String name, Data expected) Checks if the reference contains the value.
Object	get(String name) Gets the current value.
Object	getAndAlter(String name, Data function) Alters the currently stored reference by applying a function on it on and gets the old value.
Object	getAndSet(String name, Data newValue) Gets the old value and sets the new value.
Object	isNull(String name) Checks if the stored reference is null.
void	set(String name, Data newValue) Atomically sets the given value.
Object	setAndGet(String name, Data newValue) Sets and gets the value.

Method Detail

apply

Object apply(String name,
           Data function)

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

Parameters:

name - Name of the AtomicReference distributed object instance.

function - the function applied on the value, the stored value does not change

Returns:

the result of the function application

alter

void alter(String name,
         Data function)

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

Parameters:

name - Name of the AtomicReference distributed object instance.

function - the function that alters the currently stored reference

alterAndGet

Object alterAndGet(String name,
                 Data function)

Alters the currently stored reference by applying a function on it and gets the result.

Parameters:

name - Name of the AtomicReference distributed object instance.

function - the function that alters the currently stored reference

Returns:

the new value, the result of the applied function.

getAndAlter

Object getAndAlter(String name,
                 Data function)

Alters the currently stored reference by applying a function on it on and gets the old value.

Parameters:

name - Name of the AtomicReference distributed object instance.

function - the function that alters the currently stored reference

Returns:

the old value, the value before the function is applied

contains

Object contains(String name,
              @Nullable
              Data expected)

Checks if the reference contains the value.

Parameters:

name - Name of the AtomicReference distributed object instance.

expected - the value to check (is allowed to be null).

Returns:

true if the value is found, false otherwise.

compareAndSet

Object compareAndSet(String name,
                   @Nullable
                   Data expected,
                   @Nullable
                   Data updated)

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

Parameters:

name - Name of the AtomicReference distributed object 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(String name)

Gets the current value.

Parameters:

name - Name of the AtomicReference distributed object instance.

Returns:

the current value

set

void set(String name,
       @Nullable
       Data newValue)

Atomically sets the given value.

Parameters:

name - Name of the AtomicReference distributed object instance.

newValue - the new value

clear

void clear(String name)

Clears the current stored reference.

Parameters:

name - Name of the AtomicReference distributed object instance.

getAndSet

Object getAndSet(String name,
               @Nullable
               Data newValue)

Gets the old value and sets the new value.

Parameters:

name - Name of the AtomicReference distributed object instance.

newValue - the new value.

Returns:

the old value.

setAndGet

Object setAndGet(String name,
               @Nullable
               Data newValue)

Sets and gets the value.

Parameters:

name - Name of the AtomicReference distributed object instance.

newValue - the new value

Returns:

the new value

isNull

Object isNull(String name)

Checks if the stored reference is null.

Parameters:

name - Name of the AtomicReference distributed object instance.

Returns:

true if null, false otherwise.