hbase-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From st...@apache.org
Subject [46/52] [partial] hbase-site git commit: Published site at 61220e4d7c8d7e5fb8ed3bbe2469bc86632c48de.
Date Wed, 07 Dec 2016 18:24:52 GMT
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/d9f3c819/apidocs/org/apache/hadoop/hbase/Cell.html
----------------------------------------------------------------------
diff --git a/apidocs/org/apache/hadoop/hbase/Cell.html b/apidocs/org/apache/hadoop/hbase/Cell.html
index 3a1f30e..fbf171c 100644
--- a/apidocs/org/apache/hadoop/hbase/Cell.html
+++ b/apidocs/org/apache/hadoop/hbase/Cell.html
@@ -208,11 +208,15 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>byte[]</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getTagsArray--">getTagsArray</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getTagsArray--">getTagsArray</a></span>()</code>
+<div class="block">Contiguous raw bytes representing tags that may start at any index
in the containing array.</div>
+</td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code>int</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getTagsLength--">getTagsLength</a></span>()</code>&nbsp;</td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getTagsLength--">getTagsLength</a></span>()</code>
+<div class="block">HBase internally uses 2 bytes to store tags length in Cell.</div>
+</td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code>int</code></td>
@@ -468,7 +472,8 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html
 <ul class="blockList">
 <li class="blockList">
 <h4>getTagsArray</h4>
-<pre>byte[]&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.175">getTagsArray</a>()</pre>
+<pre>byte[]&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.176">getTagsArray</a>()</pre>
+<div class="block">Contiguous raw bytes representing tags that may start at any index
in the containing array.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the tags byte array</dd>
@@ -481,7 +486,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html
 <ul class="blockList">
 <li class="blockList">
 <h4>getTagsOffset</h4>
-<pre>int&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.180">getTagsOffset</a>()</pre>
+<pre>int&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.181">getTagsOffset</a>()</pre>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the first offset where the tags start in the Cell</dd>
@@ -494,7 +499,12 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html
 <ul class="blockListLast">
 <li class="blockList">
 <h4>getTagsLength</h4>
-<pre>int&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.185">getTagsLength</a>()</pre>
+<pre>int&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.192">getTagsLength</a>()</pre>
+<div class="block">HBase internally uses 2 bytes to store tags length in Cell.
+ As the tags length is always a non-negative number, to make good use of the sign bit,
+ the max of tags length is defined as <code>TagUtil.MAX_TAGS_LENGTH</code>, which
is 2 * Short.MAX_VALUE + 1 = 65535.
+ As a result, the return type is int, because a short is not capable of handling that.
+ Please note that even if the return type is int, the max tags length is far less than Integer.MAX_VALUE.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the total length of the tags in the Cell.</dd>


Mime
View raw message