From 8e2d410195b1797e2d7e647db431e4fde98aeaba Mon Sep 17 00:00:00 2001 From: Michael Stack Date: Tue, 25 Oct 2016 14:33:22 -0700 Subject: [PATCH] HBASE-16000 Table#checkAndPut() docs are too vague (Csaba Skrabak) This is a reapply of a revert just to fix the commit message This reverts commit 9c6d123b224f63d8456680dcc5c701d04954634e. --- .../org/apache/hadoop/hbase/client/Table.java | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Table.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Table.java index 4d93442ea6f..016894b5f9e 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Table.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Table.java @@ -231,7 +231,12 @@ public interface Table extends Closeable { /** * Atomically checks if a row/family/qualifier value matches the expected * value. If it does, it adds the put. If the passed value is null, the check - * is for the lack of column (ie: non-existance) + * is for the lack of column (ie: non-existence) + * + * The expected value argument of this call is on the left and the current + * value of the cell is on the right side of the comparison operator. + * + * Ie. eg. GREATER operator means expected value > existing <=> add the put. * * @param row to check * @param family column family to check @@ -286,7 +291,12 @@ public interface Table extends Closeable { /** * Atomically checks if a row/family/qualifier value matches the expected * value. If it does, it adds the delete. If the passed value is null, the - * check is for the lack of column (ie: non-existance) + * check is for the lack of column (ie: non-existence) + * + * The expected value argument of this call is on the left and the current + * value of the cell is on the right side of the comparison operator. + * + * Ie. eg. GREATER operator means expected value > existing <=> add the delete. * * @param row to check * @param family column family to check @@ -555,6 +565,11 @@ public interface Table extends Closeable { * If it does, it performs the row mutations. If the passed value is null, the check * is for the lack of column (ie: non-existence) * + * The expected value argument of this call is on the left and the current + * value of the cell is on the right side of the comparison operator. + * + * Ie. eg. GREATER operator means expected value > existing <=> perform row mutations. + * * @param row to check * @param family column family to check * @param qualifier column qualifier to check