HBASE-1751 Fix KeyValue javadoc on getValue for client-side

git-svn-id: https://svn.apache.org/repos/asf/hadoop/hbase/trunk@811577 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack 2009-09-05 00:00:04 +00:00
parent d5e3f6c894
commit 3dcb8b2625
3 changed files with 9 additions and 6 deletions

View File

@ -13,6 +13,7 @@ Release 0.21.0 - Unreleased
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

View File

@ -825,8 +825,10 @@ public class KeyValue implements Writable, HeapSize {
}
/**
* 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() {

View File

@ -141,7 +141,7 @@ public class Result implements Writable {
* 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 @@ public class Result implements Writable {
/**
* 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 @@ public class Result implements Writable {
/**
* 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 @@ public class Result implements Writable {
}
return results;
}
}
}