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

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 2.0.0
• Component/s: documentation
• Labels: beginner
• Hadoop Flags: Reviewed
• Assignee: Csaba Skrabak
• Reporter: Nick Dimiduk
• Created: 09/Jun/16 17:41
• Updated: 16/Aug/17 09:06
• Resolved: 25/Oct/16 16:20

Description

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.