io.atomix.core.counter

Interface AtomicCounter

All Superinterfaces:

DistributedPrimitive, SyncPrimitive

public interface AtomicCounter
extends SyncPrimitive

Distributed version of java.util.concurrent.atomic.AtomicLong.

Field Summary

Fields inherited from interface io.atomix.primitive.DistributedPrimitive

DEFAULT_OPERATION_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method and Description
long	addAndGet(long delta) Atomically adds the given value to the current value.
AsyncAtomicCounter	async() Returns the underlying asynchronous primitive.
boolean	compareAndSet(long expectedValue, long updateValue) Atomically sets the given counter to the updated value if the current value is the expected value, otherwise no change occurs.
long	decrementAndGet() Atomically decrement by one and return the updated value.
long	get() Returns the current value of the counter without modifying it.
long	getAndAdd(long delta) Atomically adds the given value to the current value.
long	getAndDecrement() Atomically decrement by one and return the previous value.
long	getAndIncrement() Atomically increment by one and return the previous value.
long	incrementAndGet() Atomically increment by one and return the updated value.
void	set(long value) Atomically sets the given value to the current value.

Methods inherited from interface io.atomix.primitive.SyncPrimitive

close, delete

Methods inherited from interface io.atomix.primitive.DistributedPrimitive

addStateChangeListener, name, protocol, removeStateChangeListener, type

Method Detail

incrementAndGet

long incrementAndGet()

Atomically increment by one and return the updated value.

Returns:

updated value

decrementAndGet

long decrementAndGet()

Atomically decrement by one and return the updated value.

Returns:

updated value

getAndIncrement

long getAndIncrement()

Atomically increment by one and return the previous value.

Returns:

previous value

getAndDecrement

long getAndDecrement()

Atomically decrement by one and return the previous value.

Returns:

previous value

getAndAdd

long getAndAdd(long delta)

Atomically adds the given value to the current value.

Parameters:

delta - the value to add

Returns:

previous value

addAndGet

long addAndGet(long delta)

Atomically adds the given value to the current value.

Parameters:

delta - the value to add

Returns:

updated value

set

void set(long value)

Atomically sets the given value to the current value.

Parameters:

value - the value to set

compareAndSet

boolean compareAndSet(long expectedValue,
                      long updateValue)

Atomically sets the given counter to the updated value if the current value is the expected value, otherwise no change occurs.

Parameters:

expectedValue - the expected current value of the counter

updateValue - the new value to be set

Returns:

true if the update occurred and the expected value was equal to the current value, false otherwise

get

long get()

Returns the current value of the counter without modifying it.

Returns:

current value

async

AsyncAtomicCounter async()

Description copied from interface: SyncPrimitive

Returns the underlying asynchronous primitive.

Specified by:

async in interface SyncPrimitive

Returns:

the underlying asynchronous primitive