Browse Source

HADOOP-6654. Fix code example in WritableComparable javadoc. Contributed by Tom White

git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/trunk@927979 13f79535-47bb-0310-9956-ffa450edef68
Tsz-wo Sze 15 years ago
parent
commit
6f35c10aab
2 changed files with 10 additions and 5 deletions
  1. 3 0
      CHANGES.txt
  2. 7 5
      src/java/org/apache/hadoop/io/WritableComparable.java

+ 3 - 0
CHANGES.txt

@@ -303,6 +303,9 @@ Trunk (unreleased changes)
     HADOOP-6645. Re: Bugs on listStatus for HarFileSystem (rodrigo via
     mahadev)
 
+    HADOOP-6654. Fix code example in WritableComparable javadoc.  (Tom White
+    via szetszwo)
+
 Release 0.21.0 - Unreleased
 
   INCOMPATIBLE CHANGES

+ 7 - 5
src/java/org/apache/hadoop/io/WritableComparable.java

@@ -28,7 +28,9 @@ package org.apache.hadoop.io;
  *  
  * <p>Example:</p>
  * <p><blockquote><pre>
- *     public class MyWritableComparable implements WritableComparable {
+ *     public class MyWritableComparable implements
+ *         WritableComparable&lt;MyWritableComparable&gt; {
+ *
  *       // Some data
  *       private int counter;
  *       private long timestamp;
@@ -43,10 +45,10 @@ package org.apache.hadoop.io;
  *         timestamp = in.readLong();
  *       }
  *       
- *       public int compareTo(MyWritableComparable w) {
- *         int thisValue = this.value;
- *         int thatValue = ((IntWritable)o).value;
- *         return (thisValue &lt; thatValue ? -1 : (thisValue==thatValue ? 0 : 1));
+ *       public int compareTo(MyWritableComparable other) {
+ *         int thisValue = this.counter;
+ *         int thatValue = other.counter;
+ *         return (thisValue &lt; thatValue ? -1 : (thisValue == thatValue ? 0 : 1));
  *       }
  *     }
  * </pre></blockquote></p>