io.vertx.axle.core.shareddata

Class Counter

java.lang.Object

io.vertx.axle.core.shareddata.Counter

public class Counter
extends Object

An asynchronous counter that can be used to across the cluster to maintain a consistent count.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field and Description
static TypeArg<Counter>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
Counter(io.vertx.core.shareddata.Counter delegate)

Method Summary

Modifier and Type	Method and Description
CompletionStage<Long>	addAndGet(long value) Add the value to the counter atomically and return the new count
CompletionStage<Boolean>	compareAndSet(long expected, long value) Set the counter to the specified value only if the current value is the expectec value.
CompletionStage<Long>	decrementAndGet() Decrement the counter atomically and return the new count
boolean	equals(Object o)
CompletionStage<Long>	get() Get the current value of the counter
CompletionStage<Long>	getAndAdd(long value) Add the value to the counter atomically and return the value before the add
CompletionStage<Long>	getAndIncrement() Increment the counter atomically and return the value before the increment.
io.vertx.core.shareddata.Counter	getDelegate()
int	hashCode()
CompletionStage<Long>	incrementAndGet() Increment the counter atomically and return the new count
static Counter	newInstance(io.vertx.core.shareddata.Counter arg)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final TypeArg<Counter> __TYPE_ARG

Constructor Detail

Counter

public Counter(io.vertx.core.shareddata.Counter delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public io.vertx.core.shareddata.Counter getDelegate()

get

public CompletionStage<Long> get()

Get the current value of the counter

Returns:

incrementAndGet

public CompletionStage<Long> incrementAndGet()

Increment the counter atomically and return the new count

Returns:

getAndIncrement

public CompletionStage<Long> getAndIncrement()

Increment the counter atomically and return the value before the increment.

Returns:

decrementAndGet

public CompletionStage<Long> decrementAndGet()

Decrement the counter atomically and return the new count

Returns:

addAndGet

public CompletionStage<Long> addAndGet(long value)

Add the value to the counter atomically and return the new count

Parameters:

value - the value to add

Returns:

getAndAdd

public CompletionStage<Long> getAndAdd(long value)

Add the value to the counter atomically and return the value before the add

Parameters:

value - the value to add

Returns:

compareAndSet

public CompletionStage<Boolean> compareAndSet(long expected,
                                              long value)

Set the counter to the specified value only if the current value is the expectec value. This happens atomically.

Parameters:

expected - the expected value

value - the new value

Returns:

newInstance

public static Counter newInstance(io.vertx.core.shareddata.Counter arg)