svn commit: r1052933 - in /hadoop/common/trunk: CHANGES.txt src/java/org/apache/hadoop/io/RawComparator.java

[to...@apache.org]

Author: todd
Date: Sun Dec 26 20:06:27 2010
New Revision: 1052933

URL: http://svn.apache.org/viewvc?rev=1052933&view=rev
Log:
HADOOP-7078. Improve javadocs for RawComparator interface. Contributed by Harsh J Chouraria.

Modified:
    hadoop/common/trunk/CHANGES.txt
    hadoop/common/trunk/src/java/org/apache/hadoop/io/RawComparator.java

Modified: hadoop/common/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/common/trunk/CHANGES.txt?rev=1052933&r1=1052932&r2=1052933&view=diff
==============================================================================
--- hadoop/common/trunk/CHANGES.txt (original)
+++ hadoop/common/trunk/CHANGES.txt Sun Dec 26 20:06:27 2010
@@ -36,6 +36,9 @@ Trunk (unreleased changes)
 
     HADOOP-7059. Remove "unused" warning in native code.  (Noah Watkins via eli)
 
+    HADOOP-7078. Improve javadocs for RawComparator interface.
+    (Harsh J Chouraria via todd)
+
   OPTIMIZATIONS
 
   BUG FIXES

Modified: hadoop/common/trunk/src/java/org/apache/hadoop/io/RawComparator.java
URL: http://svn.apache.org/viewvc/hadoop/common/trunk/src/java/org/apache/hadoop/io/RawComparator.java?rev=1052933&r1=1052932&r2=1052933&view=diff
==============================================================================
--- hadoop/common/trunk/src/java/org/apache/hadoop/io/RawComparator.java (original)
+++ hadoop/common/trunk/src/java/org/apache/hadoop/io/RawComparator.java Sun Dec 26 20:06:27 2010
@@ -36,6 +36,18 @@ import org.apache.hadoop.io.serializer.D
 @InterfaceStability.Stable
 public interface RawComparator<T> extends Comparator<T> {
 
+  /**
+   * Compare two objects in binary.
+   * b1[s1:l1] is the first object, and b2[s2:l2] is the second object.
+   * 
+   * @param b1 The first byte array.
+   * @param s1 The position index in b1. The object under comparison's starting index.
+   * @param l1 The length of the object in b1.
+   * @param b2 The second byte array.
+   * @param s2 The position index in b2. The object under comparison's starting index.
+   * @param l2 The length of the object under comparison in b2.
+   * @return An integer result of the comparison.
+   */
   public int compare(byte[] b1, int s1, int l1, byte[] b2, int s2, int l2);
 
 }