| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Cell (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Cell (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":38,"i10":6,"i11":38,"i12":38,"i13":38,"i14":6,"i15":18,"i16":38,"i17":6,"i18":6,"i19":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Cell.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/hadoop/hbase/CallQueueTooBigException.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/hbase/CellBuilder.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/hadoop/hbase/Cell.html" target="_top">Frames</a></li> |
| <li><a href="Cell.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.hbase</div> |
| <h2 title="Interface Cell" class="title">Interface Cell</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>org.apache.hadoop.hbase.io.HeapSize</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Public |
| public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.63">Cell</a> |
| extends org.apache.hadoop.hbase.io.HeapSize</pre> |
| <div class="block">The unit of storage in HBase consisting of the following fields: |
| <br> |
| <pre> |
| 1) row |
| 2) column family |
| 3) column qualifier |
| 4) timestamp |
| 5) type |
| 6) MVCC version |
| 7) value |
| </pre> |
| <p> |
| Uniqueness is determined by the combination of row, column family, column qualifier, |
| timestamp, and type. |
| </p> |
| <p> |
| The natural comparator will perform a bitwise comparison on row, column family, and column |
| qualifier. Less intuitively, it will then treat the greater timestamp as the lesser value with |
| the goal of sorting newer cells first. |
| </p> |
| <p> |
| Cell implements Comparable<Cell> which is only meaningful when |
| comparing to other keys in the |
| same table. It uses CellComparator which does not work on the -ROOT- and hbase:meta tables. |
| </p> |
| <p> |
| In the future, we may consider adding a boolean isOnHeap() method and a getValueBuffer() method |
| that can be used to pass a value directly from an off-heap ByteBuffer to the network without |
| copying into an on-heap byte[]. |
| </p> |
| <p> |
| Historic note: the original Cell implementation (KeyValue) requires that all fields be encoded as |
| consecutive bytes in the same byte[], whereas this interface allows fields to reside in separate |
| byte[]'s. |
| </p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getFamilyArray--">getFamilyArray</a></span>()</code> |
| <div class="block">Contiguous bytes composed of legal HDFS filename characters which may start at any index in the |
| containing array.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>byte</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getFamilyLength--">getFamilyLength</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getFamilyOffset--">getFamilyOffset</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getQualifierArray--">getQualifierArray</a></span>()</code> |
| <div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getQualifierLength--">getQualifierLength</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getQualifierOffset--">getQualifierOffset</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getRowArray--">getRowArray</a></span>()</code> |
| <div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getRowLength--">getRowLength</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getRowOffset--">getRowOffset</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getSequenceId--">getSequenceId</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">As of HBase-2.0. Will be removed in HBase-3.0.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getSerializedSize--">getSerializedSize</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <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> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">As of HBase-2.0. Will be removed in HBase-3.0. Tags are are now internal.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <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> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">As of HBase-2.0. Will be removed in HBase-3.0. Tags are are now internal.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getTagsOffset--">getTagsOffset</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">As of HBase-2.0. Will be removed in HBase-3.0. Tags are are now internal.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getTimestamp--">getTimestamp</a></span>()</code> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>default org.apache.hadoop.hbase.Cell.Type</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getType--">getType</a></span>()</code> |
| <div class="block">Returns the type of cell in a human readable format using <code>Cell.Type</code>.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>byte</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getTypeByte--">getTypeByte</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">As of HBase-2.0. Will be removed in HBase-3.0. Use <a href="../../../../org/apache/hadoop/hbase/Cell.html#getType--"><code>getType()</code></a>.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getValueArray--">getValueArray</a></span>()</code> |
| <div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getValueLength--">getValueLength</a></span>()</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Cell.html#getValueOffset--">getValueOffset</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.io.HeapSize"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.hadoop.hbase.io.HeapSize</h3> |
| <code>heapSize</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getRowArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRowArray</h4> |
| <pre>byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.72">getRowArray</a>()</pre> |
| <div class="block">Contiguous raw bytes that may start at any index in the containing array. Max length is |
| Short.MAX_VALUE which is 32,767 bytes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The array containing the row bytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRowOffset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRowOffset</h4> |
| <pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.77">getRowOffset</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Array index of first row byte</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRowLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRowLength</h4> |
| <pre>short <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.82">getRowLength</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Number of row bytes. Must be < rowArray.length - offset.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFamilyArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFamilyArray</h4> |
| <pre>byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.92">getFamilyArray</a>()</pre> |
| <div class="block">Contiguous bytes composed of legal HDFS filename characters which may start at any index in the |
| containing array. Max length is Byte.MAX_VALUE, which is 127 bytes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the array containing the family bytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFamilyOffset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFamilyOffset</h4> |
| <pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.97">getFamilyOffset</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Array index of first family byte</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFamilyLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFamilyLength</h4> |
| <pre>byte <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.102">getFamilyLength</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Number of family bytes. Must be < familyArray.length - offset.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQualifierArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQualifierArray</h4> |
| <pre>byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.111">getQualifierArray</a>()</pre> |
| <div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The array containing the qualifier bytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQualifierOffset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQualifierOffset</h4> |
| <pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.116">getQualifierOffset</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Array index of first qualifier byte</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQualifierLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQualifierLength</h4> |
| <pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.121">getQualifierLength</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Number of qualifier bytes. Must be < qualifierArray.length - offset.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTimestamp--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimestamp</h4> |
| <pre>long <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.130">getTimestamp</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Long value representing time at which this cell was "Put" into the row. Typically |
| represents the time of insertion, but can be any value from 0 to Long.MAX_VALUE.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTypeByte--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTypeByte</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| byte <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.140">getTypeByte</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of HBase-2.0. Will be removed in HBase-3.0. Use <a href="../../../../org/apache/hadoop/hbase/Cell.html#getType--"><code>getType()</code></a>.</span></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSequenceId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSequenceId</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| long <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.154">getSequenceId</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of HBase-2.0. Will be removed in HBase-3.0.</span></div> |
| <div class="block">A region-specific unique monotonically increasing sequence ID given to each Cell. It always |
| exists for cells in the memstore but is not retained forever. It will be kept for |
| <a href="../../../../org/apache/hadoop/hbase/HConstants.html#KEEP_SEQID_PERIOD"><code>HConstants.KEEP_SEQID_PERIOD</code></a> days, but generally becomes irrelevant after the cell's |
| row is no longer involved in any operations that require strict consistency.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>seqId (always > 0 if exists), or 0 if it no longer exists</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueArray</h4> |
| <pre>byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.163">getValueArray</a>()</pre> |
| <div class="block">Contiguous raw bytes that may start at any index in the containing array. Max length is |
| Integer.MAX_VALUE which is 2,147,483,647 bytes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The array containing the value bytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueOffset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueOffset</h4> |
| <pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.168">getValueOffset</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Array index of first value byte</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueLength</h4> |
| <pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.173">getValueLength</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Number of value bytes. Must be < valueArray.length - offset.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSerializedSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSerializedSize</h4> |
| <pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.178">getSerializedSize</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Serialized size (defaults to include tag length if has some tags).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTagsArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTagsArray</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.186">getTagsArray</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of HBase-2.0. Will be removed in HBase-3.0. Tags are are now internal.</span></div> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTagsOffset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTagsOffset</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.193">getTagsOffset</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of HBase-2.0. Will be removed in HBase-3.0. Tags are are now internal.</span></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the first offset where the tags start in the Cell</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTagsLength--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTagsLength</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| int <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.207">getTagsLength</a>()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of HBase-2.0. Will be removed in HBase-3.0. Tags are are now internal.</span></div> |
| <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 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> |
| </dl> |
| </li> |
| </ul> |
| <a name="getType--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre>default org.apache.hadoop.hbase.Cell.Type <a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line.215">getType</a>()</pre> |
| <div class="block">Returns the type of cell in a human readable format using <code>Cell.Type</code>. |
| Note : This does not expose the internal types of Cells like <code>KeyValue.Type.Maximum</code> and |
| <code>KeyValue.Type.Minimum</code></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The data type this cell: one of Put, Delete, etc</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Cell.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/hadoop/hbase/CallQueueTooBigException.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/hbase/CellBuilder.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/hadoop/hbase/Cell.html" target="_top">Frames</a></li> |
| <li><a href="Cell.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
