Counter (Vert.x Stack - Docs 3.9.3 API)

java.lang.Object
- io.vertx.rxjava.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 io.vertx.lang.rx.TypeArg<Counter> __TYPE_ARG

Fields
Modifier and Type	Field and Description
`static io.vertx.lang.rx.TypeArg<Counter>`	`__TYPE_ARG`

Constructor Summary

Constructors
Constructor and Description

Counter(Counter delegate)

Counter(Object delegate)

Constructors
Constructor and Description
`Counter(Counter delegate)`
`Counter(Object delegate)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAndGet(long value, Handler<AsyncResult<Long>> resultHandler)` Add the value to the counter atomically and return the new count
`Observable<Long>`	`addAndGetObservable(long value)` Deprecated. use `rxAddAndGet(long)` instead
`void`	`compareAndSet(long expected, long value, Handler<AsyncResult<Boolean>> resultHandler)` Set the counter to the specified value only if the current value is the expectec value.
`Observable<Boolean>`	`compareAndSetObservable(long expected, long value)` Deprecated. use `rxCompareAndSet(long, long)` instead
`void`	`decrementAndGet(Handler<AsyncResult<Long>> resultHandler)` Decrement the counter atomically and return the new count
`Observable<Long>`	`decrementAndGetObservable()` Deprecated. use `rxDecrementAndGet()` instead
`boolean`	`equals(Object o)`
`void`	`get(Handler<AsyncResult<Long>> resultHandler)` Get the current value of the counter
`void`	`getAndAdd(long value, Handler<AsyncResult<Long>> resultHandler)` Add the value to the counter atomically and return the value before the add
`Observable<Long>`	`getAndAddObservable(long value)` Deprecated. use `rxGetAndAdd(long)` instead
`void`	`getAndIncrement(Handler<AsyncResult<Long>> resultHandler)` Increment the counter atomically and return the value before the increment.
`Observable<Long>`	`getAndIncrementObservable()` Deprecated. use `rxGetAndIncrement()` instead
`Counter`	`getDelegate()`
`Observable<Long>`	`getObservable()` Deprecated. use `rxGet()` instead
`int`	`hashCode()`
`void`	`incrementAndGet(Handler<AsyncResult<Long>> resultHandler)` Increment the counter atomically and return the new count
`Observable<Long>`	`incrementAndGetObservable()` Deprecated. use `rxIncrementAndGet()` instead
`static Counter`	`newInstance(Counter arg)`
`Single<Long>`	`rxAddAndGet(long value)` Add the value to the counter atomically and return the new count
`Single<Boolean>`	`rxCompareAndSet(long expected, long value)` Set the counter to the specified value only if the current value is the expectec value.
`Single<Long>`	`rxDecrementAndGet()` Decrement the counter atomically and return the new count
`Single<Long>`	`rxGet()` Get the current value of the counter
`Single<Long>`	`rxGetAndAdd(long value)` Add the value to the counter atomically and return the value before the add
`Single<Long>`	`rxGetAndIncrement()` Increment the counter atomically and return the value before the increment.
`Single<Long>`	`rxIncrementAndGet()` Increment the counter atomically and return the new count
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __TYPE_ARG
```
public static final io.vertx.lang.rx.TypeArg<Counter> __TYPE_ARG
```
- Constructor Detail
  - Counter
```
public Counter(Counter delegate)
```
  - Counter
```
public Counter(Object 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 Counter getDelegate()
```
  - get
```
public void get(Handler<AsyncResult<Long>> resultHandler)
```
    Get the current value of the counter
    
    Parameters:
    
    resultHandler - handler which will be passed the value
  - getObservable
```
@Deprecated
public Observable<Long> getObservable()
```
    Deprecated. use rxGet() instead
    
    Get the current value of the counter
    
    Returns:
  - rxGet
```
public Single<Long> rxGet()
```
    Get the current value of the counter
    
    Returns:
  - incrementAndGet
```
public void incrementAndGet(Handler<AsyncResult<Long>> resultHandler)
```
    Increment the counter atomically and return the new count
    
    Parameters:
    
    resultHandler - handler which will be passed the value
  - incrementAndGetObservable
```
@Deprecated
public Observable<Long> incrementAndGetObservable()
```
    Deprecated. use rxIncrementAndGet() instead
    
    Increment the counter atomically and return the new count
    
    Returns:
  - rxIncrementAndGet
```
public Single<Long> rxIncrementAndGet()
```
    Increment the counter atomically and return the new count
    
    Returns:
  - getAndIncrement
```
public void getAndIncrement(Handler<AsyncResult<Long>> resultHandler)
```
    Increment the counter atomically and return the value before the increment.
    
    Parameters:
    
    resultHandler - handler which will be passed the value
  - getAndIncrementObservable
```
@Deprecated
public Observable<Long> getAndIncrementObservable()
```
    Deprecated. use rxGetAndIncrement() instead
    
    Increment the counter atomically and return the value before the increment.
    
    Returns:
  - rxGetAndIncrement
```
public Single<Long> rxGetAndIncrement()
```
    Increment the counter atomically and return the value before the increment.
    
    Returns:
  - decrementAndGet
```
public void decrementAndGet(Handler<AsyncResult<Long>> resultHandler)
```
    Decrement the counter atomically and return the new count
    
    Parameters:
    
    resultHandler - handler which will be passed the value
  - decrementAndGetObservable
```
@Deprecated
public Observable<Long> decrementAndGetObservable()
```
    Deprecated. use rxDecrementAndGet() instead
    
    Decrement the counter atomically and return the new count
    
    Returns:
  - rxDecrementAndGet
```
public Single<Long> rxDecrementAndGet()
```
    Decrement the counter atomically and return the new count
    
    Returns:
  - addAndGet
```
public void addAndGet(long value,
                      Handler<AsyncResult<Long>> resultHandler)
```
    Add the value to the counter atomically and return the new count
    
    Parameters:
    
    value - the value to add
    
    resultHandler - handler which will be passed the value
  - addAndGetObservable
```
@Deprecated
public Observable<Long> addAndGetObservable(long value)
```
    Deprecated. use rxAddAndGet(long) instead
    
    Add the value to the counter atomically and return the new count
    
    Parameters:
    
    value - the value to add
    
    Returns:
  - rxAddAndGet
```
public Single<Long> rxAddAndGet(long value)
```
    Add the value to the counter atomically and return the new count
    
    Parameters:
    
    value - the value to add
    
    Returns:
  - getAndAdd
```
public void getAndAdd(long value,
                      Handler<AsyncResult<Long>> resultHandler)
```
    Add the value to the counter atomically and return the value before the add
    
    Parameters:
    
    value - the value to add
    
    resultHandler - handler which will be passed the value
  - getAndAddObservable
```
@Deprecated
public Observable<Long> getAndAddObservable(long value)
```
    Deprecated. use rxGetAndAdd(long) instead
    
    Add the value to the counter atomically and return the value before the add
    
    Parameters:
    
    value - the value to add
    
    Returns:
  - rxGetAndAdd
```
public Single<Long> rxGetAndAdd(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 void compareAndSet(long expected,
                          long value,
                          Handler<AsyncResult<Boolean>> resultHandler)
```
    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
    
    resultHandler - the handler will be passed true on success
  - compareAndSetObservable
```
@Deprecated
public Observable<Boolean> compareAndSetObservable(long expected,
                                                               long value)
```
    Deprecated. use rxCompareAndSet(long, long) instead
    
    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:
  - rxCompareAndSet
```
public Single<Boolean> rxCompareAndSet(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(Counter arg)
```

Class Counter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__TYPE_ARG

Constructor Detail

Counter

Counter

Method Detail

toString

equals

hashCode

getDelegate

get

getObservable

rxGet

incrementAndGet

incrementAndGetObservable

rxIncrementAndGet

getAndIncrement

getAndIncrementObservable

rxGetAndIncrement

decrementAndGet

decrementAndGetObservable

rxDecrementAndGet

addAndGet

addAndGetObservable

rxAddAndGet

getAndAdd

getAndAddObservable

rxGetAndAdd

compareAndSet

compareAndSetObservable

rxCompareAndSet

newInstance