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

Class RegisterUpdate

java.lang.Object

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

All Implemented Interfaces:

DatatypeUpdate

public class RegisterUpdate
extends Object
implements DatatypeUpdate

An update to a Riak register datatype.

When building an UpdateMap command this class is used to encapsulate the update to be performed on a Riak register datatype contained in the map. It is used in conjunction with the MapUpdate.

Since:

2.0

Author:

Dave Rusek

Constructor Summary

Constructors

Constructor and Description
RegisterUpdate(BinaryValue value) Construct a RegisterUpdate with the provided BinaryValue.
RegisterUpdate(byte[] value) Construct a RegisterUpdate with the provided bytes.
RegisterUpdate(String value) Construct a RegisterUpdate with the provided String.

Method Summary

Methods

Modifier and Type	Method and Description
BinaryValue	get() Get the register contained in this update.
RegisterOp	getOp() Returns the core update.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisterUpdate

public RegisterUpdate(byte[] value)

Construct a RegisterUpdate with the provided bytes.

Parameters:

value - the bytes representing the register.

RegisterUpdate

public RegisterUpdate(BinaryValue value)

Construct a RegisterUpdate with the provided BinaryValue.

Parameters:

value - the BinaryValue representing the register.

RegisterUpdate

public RegisterUpdate(String value)

Construct a RegisterUpdate with the provided String.

Note the String is converted to bytes using the default Charset.

Parameters:

value - the String representing the register.

Method Detail

get

public BinaryValue get()

Get the register contained in this update.

Returns:

the register as a BinaryValue.

getOp

public RegisterOp getOp()

Returns the core update.

Specified by:

getOp in interface DatatypeUpdate

Returns:

the update used by the client core.

toString

public String toString()

Overrides:

toString in class Object