com.basho.riak.client.api.commands.datatypes

Class CounterUpdate

java.lang.Object

com.basho.riak.client.api.commands.datatypes.CounterUpdate

All Implemented Interfaces:

DatatypeUpdate

public class CounterUpdate
extends Object
implements DatatypeUpdate

An update to a Riak counter datatype.

When building a UpdateCounter or UpdateMap command this class is used to encapsulate the update to be performed on a Riak counter datatype.

Since:

2.0

Author:

Dave Rusek

Constructor Summary

Constructors

Constructor and Description
CounterUpdate() Constructs a CounterUpdate with a delta of 0 (zero).
CounterUpdate(long delta) Constructs a CounterUpdate with the supplied delta.

Method Summary

Methods

Modifier and Type	Method and Description
long	getDelta() Get the delta.
CounterOp	getOp() Returns the core update.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CounterUpdate

public CounterUpdate()

Constructs a CounterUpdate with a delta of 0 (zero).

CounterUpdate

public CounterUpdate(long delta)

Constructs a CounterUpdate with the supplied delta.

To decrease a counter supply a negative value.

Parameters:

delta - the value to add to the counter in Riak.

Method Detail

getDelta

public long getDelta()

Get the delta.

Returns:

the value contained in this CounterUpdate.

getOp

public CounterOp getOp()

Returns the core update.

Specified by:

getOp in interface DatatypeUpdate

Returns:

the update used by the client core.