org.apache.hadoop.hbase.client

Class CheckAndMutate

java.lang.Object

org.apache.hadoop.hbase.client.CheckAndMutate

All Implemented Interfaces:

Comparable<Row>, Row

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public final class CheckAndMutate
extends Object
implements Row

Used to perform CheckAndMutate operations.

Use the builder class to instantiate a CheckAndMutate object. This builder class is fluent style APIs, the code are like:

 
 // A CheckAndMutate operation where do the specified action if the column (specified by the
 // family and the qualifier) of the row equals to the specified value
 CheckAndMutate checkAndMutate = CheckAndMutate.newBuilder(row)
   .ifEquals(family, qualifier, value)
   .build(put);

 // A CheckAndMutate operation where do the specified action if the column (specified by the
 // family and the qualifier) of the row doesn't exist
 CheckAndMutate checkAndMutate = CheckAndMutate.newBuilder(row)
   .ifNotExists(family, qualifier)
   .build(put);

 // A CheckAndMutate operation where do the specified action if the row matches the filter
 CheckAndMutate checkAndMutate = CheckAndMutate.newBuilder(row)
   .ifMatches(filter)
   .build(delete);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckAndMutate.Builder A builder class for building a CheckAndMutate object.

Field Summary

Fields

Modifier and Type	Field and Description
private Row	action
private byte[]	family
private Filter	filter
private CompareOperator	op
private byte[]	qualifier
private byte[]	row
private TimeRange	timeRange
private byte[]	value

Fields inherited from interface org.apache.hadoop.hbase.client.Row

COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
private	CheckAndMutate(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, byte[] value, TimeRange timeRange, Row action)
private	CheckAndMutate(byte[] row, Filter filter, TimeRange timeRange, Row action)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Row row) Compare this row to another row.
boolean	equals(Object obj)
Row	getAction() Returns the action done if check succeeds
CompareOperator	getCompareOp() Returns the comparison operator
byte[]	getFamily() Returns the family to check
Filter	getFilter() Returns the filter to check
byte[]	getQualifier() Returns the qualifier to check
byte[]	getRow() Returns the row
TimeRange	getTimeRange() Returns the time range to check
byte[]	getValue() Returns the expected value
boolean	hasFilter() Returns whether this has a filter or not
int	hashCode()
static CheckAndMutate.Builder	newBuilder(byte[] row) returns a builder object to build a CheckAndMutate object

Methods inherited from class java.lang.Object

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

Field Detail

row

private final byte[] row

family

private final byte[] family

qualifier

private final byte[] qualifier

op

private final CompareOperator op

value

private final byte[] value

filter

private final Filter filter

timeRange

private final TimeRange timeRange

action

private final Row action

Constructor Detail

CheckAndMutate

private CheckAndMutate(byte[] row,
                       byte[] family,
                       byte[] qualifier,
                       CompareOperator op,
                       byte[] value,
                       TimeRange timeRange,
                       Row action)

CheckAndMutate

private CheckAndMutate(byte[] row,
                       Filter filter,
                       TimeRange timeRange,
                       Row action)

Method Detail

newBuilder

public static CheckAndMutate.Builder newBuilder(byte[] row)

returns a builder object to build a CheckAndMutate object

Parameters:

row - row

Returns:

a builder object

getRow

public byte[] getRow()

Returns the row

Specified by:

getRow in interface Row

compareTo

public int compareTo(Row row)

Description copied from interface: Row

Compare this row to another row.

Specified by:

compareTo in interface Comparable<Row>

Specified by:

compareTo in interface Row

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getFamily

public byte[] getFamily()

Returns the family to check

getQualifier

public byte[] getQualifier()

Returns the qualifier to check

getCompareOp

public CompareOperator getCompareOp()

Returns the comparison operator

getValue

public byte[] getValue()

Returns the expected value

getFilter

public Filter getFilter()

Returns the filter to check

hasFilter

public boolean hasFilter()

Returns whether this has a filter or not

getTimeRange

public TimeRange getTimeRange()

Returns the time range to check

getAction

public Row getAction()

Returns the action done if check succeeds