org.gridgain.grid.cache.datastructures

Interface GridCacheAtomicStamped<T,S>

All Known Subinterfaces:

GridCacheAtomicStampedEx<T,S>

All Known Implementing Classes:

GridCacheAtomicStampedImpl

public interface GridCacheAtomicStamped<T,S>

This interface provides a rich API for working with distributed atomic stamped value.

Functionality

Distributed atomic stamped includes the following main functionality:

• Method get() synchronously gets both value and stamp of atomic.
• Method value() synchronously gets current value of atomic.
• Method stamp() synchronously gets current stamp of atomic.
• Method set(Object, Object) synchronously and unconditionally sets the value and the stamp in the atomic.
• Methods compareAndSet(...) synchronously and conditionally set the value and the stamp in the atomic.

All previously described methods have asynchronous analogs.

• Method name() gets name of atomic stamped.

Creating Distributed Atomic Stamped

Instance of distributed atomic stamped can be created by calling the following method:

• GridCacheDataStructures.atomicLong(String, long, boolean)

See Also:

GridCacheDataStructures.atomicStamped(String, Object, Object, boolean), GridCacheDataStructures.removeAtomicStamped(String)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	compareAndSet(T expVal, T newVal, S expStamp, S newStamp) Conditionally sets the new value and new stamp.
GridBiTuple<T,S>	get() Gets both current value and current stamp of atomic stamped.
String	name() Name of atomic stamped.
boolean	removed() Gets status of atomic.
void	set(T val, S stamp) Unconditionally sets the value and the stamp.
S	stamp() Gets current stamp.
T	value() Gets current value.

Method Detail

name

String name()

Name of atomic stamped.

Returns:

Name of atomic stamped.

get

GridBiTuple<T,S> get()
                     throws GridException

Gets both current value and current stamp of atomic stamped.

Returns:

both current value and current stamp of atomic stamped.

Throws:

GridException - If operation failed.

set

void set(T val,
       S stamp)
         throws GridException

Unconditionally sets the value and the stamp.

Parameters:

val - Value.

stamp - Stamp.

Throws:

GridException - If operation failed.

compareAndSet

boolean compareAndSet(T expVal,
                    T newVal,
                    S expStamp,
                    S newStamp)
                      throws GridException

Conditionally sets the new value and new stamp. They will be set if expVal and expStamp are equal to current value and current stamp respectively.

Parameters:

expVal - Expected value.

newVal - New value.

expStamp - Expected stamp.

newStamp - New stamp.

Returns:

Result of operation execution. If true than value and stamp will be updated.

Throws:

GridException - If operation failed.

stamp

S stamp()
        throws GridException

Gets current stamp.

Returns:

Current stamp.

Throws:

GridException - If operation failed.

value

T value()
        throws GridException

Gets current value.

Returns:

Current value.

Throws:

GridException - If operation failed.

removed

boolean removed()

Gets status of atomic.

Returns:

true if atomic stamped was removed from cache, false otherwise.