org.gridgain.grid.cache.datastructures

Interface GridCacheAtomicLong

All Known Subinterfaces:

GridCacheAtomicLongEx

All Known Implementing Classes:

GridCacheAtomicLongImpl

public interface GridCacheAtomicLong

This interface provides a rich API for working with distributedly cached atomic long value.

Functionality

Distributed atomic long includes the following main functionality:

• Method get() synchronously gets current value of atomic long.
• Various get..(..) methods synchronously get current value of atomic long and increase or decrease value of atomic long.
• Method addAndGet(long l) synchronously sums l with current value of atomic long and returns result.
• Method incrementAndGet() synchronously increases value of atomic long and returns result.
• Method decrementAndGet() synchronously decreases value of atomic long and returns result.
• Method getAndSet(long l) synchronously gets current value of atomic long and sets l as value of atomic long.

All previously described methods have asynchronous analogs.

• Method name() gets name of atomic long.

Creating Distributed Atomic Long

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

• GridCacheDataStructures.atomicLong(String, long, boolean)

See Also:

GridCacheDataStructures.atomicLong(String, long, boolean), GridCacheDataStructures.removeAtomicLong(String)

Method Summary

Methods

Modifier and Type	Method and Description
long	addAndGet(long l) Adds l and gets current value of atomic long.
boolean	compareAndSet(long expVal, long newVal) Atomically compares current value to the expected value, and if they are equal, sets current value to new value.
long	decrementAndGet() Decrements and gets current value of atomic long.
long	get() Gets current value of atomic long.
long	getAndAdd(long l) Gets current value of atomic long and adds l.
long	getAndDecrement() Gets and decrements current value of atomic long.
long	getAndIncrement() Gets and increments current value of atomic long.
long	getAndSet(long l) Gets current value of atomic long and sets new value l of atomic long.
long	incrementAndGet() Increments and gets current value of atomic long.
String	name() Name of atomic long.
boolean	removed() Gets status of atomic.

Method Detail

name

String name()

Name of atomic long.

Returns:

Name of atomic long.

get

long get()
         throws GridException

Gets current value of atomic long.

Returns:

Current value of atomic long.

Throws:

GridException - If operation failed.

incrementAndGet

long incrementAndGet()
                     throws GridException

Increments and gets current value of atomic long.

Returns:

Value.

Throws:

GridException - If operation failed.

getAndIncrement

long getAndIncrement()
                     throws GridException

Gets and increments current value of atomic long.

Returns:

Value.

Throws:

GridException - If operation failed.

addAndGet

long addAndGet(long l)
               throws GridException

Adds l and gets current value of atomic long.

Parameters:

l - Number which will be added.

Returns:

Value.

Throws:

GridException - If operation failed.

getAndAdd

long getAndAdd(long l)
               throws GridException

Gets current value of atomic long and adds l.

Parameters:

l - Number which will be added.

Returns:

Value.

Throws:

GridException - If operation failed.

decrementAndGet

long decrementAndGet()
                     throws GridException

Decrements and gets current value of atomic long.

Returns:

Value.

Throws:

GridException - If operation failed.

getAndDecrement

long getAndDecrement()
                     throws GridException

Gets and decrements current value of atomic long.

Returns:

Value.

Throws:

GridException - If operation failed.

getAndSet

long getAndSet(long l)
               throws GridException

Gets current value of atomic long and sets new value l of atomic long.

Parameters:

l - New value of atomic long.

Returns:

Value.

Throws:

GridException - If operation failed.

compareAndSet

boolean compareAndSet(long expVal,
                    long newVal)
                      throws GridException

Atomically compares current value to the expected value, and if they are equal, sets current value to new value.

Parameters:

expVal - Expected atomic long's value.

newVal - New atomic long's value to set if current value equal to expected value.

Returns:

True if comparison succeeded, false otherwise.

Throws:

GridException - If failed.

removed

boolean removed()

Gets status of atomic.

Returns:

true if atomic was removed from cache, false in other case.