svn commit: r811577 - in /hadoop/hbase/trunk: CHANGES.txt src/java/org/apache/hadoop/hbase/KeyValue.java src/java/org/apache/hadoop/hbase/client/Result.java

[st...@apache.org]

Author: stack
Date: Sat Sep  5 00:00:04 2009
New Revision: 811577

URL: http://svn.apache.org/viewvc?rev=811577&view=rev
Log:
HBASE-1751  Fix KeyValue javadoc on getValue for client-side

Modified:
    hadoop/hbase/trunk/CHANGES.txt
    hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/KeyValue.java
    hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/Result.java

Modified: hadoop/hbase/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/CHANGES.txt?rev=811577&r1=811576&r2=811577&view=diff
==============================================================================
--- hadoop/hbase/trunk/CHANGES.txt (original)
+++ hadoop/hbase/trunk/CHANGES.txt Sat Sep  5 00:00:04 2009
@@ -13,6 +13,7 @@
    HBASE-1790  filters are not working correctly (HBASE-1710 HBASE-1807 too)
    HBASE-1779  ThriftServer logged error if getVer() result is empty
    HBASE-1778  Improve PerformanceEvaluation (Schubert Zhang via Stack)
+   HBASE-1751  Fix KeyValue javadoc on getValue for client-side
 
   IMPROVEMENTS
    HBASE-1760  Cleanup TODOs in HTable

Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/KeyValue.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/KeyValue.java?rev=811577&r1=811576&r2=811577&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/KeyValue.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/KeyValue.java Sat Sep  5 00:00:04 2009
@@ -825,8 +825,10 @@
   }
   
   /**
-   * Do not use unless you have to.  Use {@link #getBuffer()} with appropriate
-   * offset and lengths instead.
+   * Returns value in a new byte array.
+   * Primarily for use client-side. If server-side, use
+   * {@link #getBuffer()} with appropriate offsets and lengths instead to
+   * save on allocations.
    * @return Value in a new byte array.
    */
   public byte [] getValue() {

Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/Result.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/Result.java?rev=811577&r1=811576&r2=811577&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/Result.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/client/Result.java Sat Sep  5 00:00:04 2009
@@ -141,7 +141,7 @@
    * Map of families to all versions of its qualifiers and values.
    * <p>
    * Returns a three level Map of the form: 
-   * <code>Map<family,Map<qualifier,Map<timestamp,value>>></code>
+   * <code>Map<family,Map&lt;qualifier,Map&lt;timestamp,value>>></code>
    * <p>
    * Note: All other map returning methods make use of this map internally. 
    * @return map from families to qualifiers to versions
@@ -186,7 +186,7 @@
   /**
    * Map of families to their most recent qualifiers and values.
    * <p>
-   * Returns a two level Map of the form: <code>Map<family,Map<qualifier,value>></code>
+   * Returns a two level Map of the form: <code>Map<family,Map&lt;qualifier,value>></code>
    * <p>
    * The most recent version of each qualifier will be used.
    * @return map from families to qualifiers and value
@@ -218,7 +218,7 @@
   /**
    * Map of qualifiers to values.
    * <p>
-   * Returns a Map of the form: <code>Map<qualifier,value></code>
+   * Returns a Map of the form: <code>Map&lt;qualifier,value></code>
    * @return map of qualifiers to values
    */
   public NavigableMap<byte[], byte[]> getFamilyMap(byte [] family) {
@@ -499,4 +499,4 @@
     }
     return results;
   }
-}
\ No newline at end of file
+}