[jira] [Created] (HBASE-16000) Table#checkAndPut() docs are too vague

["Nick Dimiduk (JIRA)" <ji...@apache.org>]

Nick Dimiduk created HBASE-16000:
------------------------------------

             Summary: Table#checkAndPut() docs are too vague
                 Key: HBASE-16000
                 URL: https://issues.apache.org/jira/browse/HBASE-16000
             Project: HBase
          Issue Type: Bug
          Components: documentation
            Reporter: Nick Dimiduk
            Priority: Minor


The docs for our CAS operations that accept a {{CompareOp}} are too vague. They're copied from the part that implies {{CompareOp.EQUAL}}, which means they don't tell you how your op, the provided {{value}}, and any present value are compared.

Only by digging into HRegion.java can I see that the operation is, for example with CompareOp.GREATER, we get {{value.compareTo(existingKeyValue) > 0}}. Javadocs should be explicit about the order of operands.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)