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

Class FlagUpdate

java.lang.Object

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

All Implemented Interfaces:

DatatypeUpdate

public class FlagUpdate
extends Object
implements DatatypeUpdate

An update to a Riak flag datatype.

When building an UpdateMap command this class is used to encapsulate the update to be performed on a Riak flag 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
FlagUpdate() Construct a FlagUpdate with the default disabled (false) value.
FlagUpdate(boolean flag) Construct a FlagUpdate.

Method Summary

Methods

Modifier and Type	Method and Description
FlagOp	getOp() Returns the core update.
boolean	isEnabled() Return the value of this FlagUpdate.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlagUpdate

public FlagUpdate(boolean flag)

Construct a FlagUpdate.

Parameters:

flag - true to enable, false to disable.

FlagUpdate

public FlagUpdate()

Construct a FlagUpdate with the default disabled (false) value.

Method Detail

isEnabled

public boolean isEnabled()

Return the value of this FlagUpdate.

Returns:

true if enabled, false if disabled.

getOp

public FlagOp getOp()

Returns the core update.

Specified by:

getOp in interface DatatypeUpdate

Returns:

the update used by the client core.