| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Cell (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase, interface: Cell"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase</a></div> |
| <h1 title="Interface Cell" class="title">Interface Cell</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="io/HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></code>, <code><a href="RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="io/encoding/BufferedDataBlockEncoder.OffheapDecodedExtendedCell.html" title="class in org.apache.hadoop.hbase.io.encoding">BufferedDataBlockEncoder.OffheapDecodedExtendedCell</a></code>, <code><a href="io/encoding/BufferedDataBlockEncoder.OnheapDecodedCell.html" title="class in org.apache.hadoop.hbase.io.encoding">BufferedDataBlockEncoder.OnheapDecodedCell</a></code>, <code><a href="regionserver/ByteBufferChunkKeyValue.html" title="class in org.apache.hadoop.hbase.regionserver">ByteBufferChunkKeyValue</a></code>, <code><a href="ByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">ByteBufferExtendedCell</a></code>, <code><a href="ByteBufferKeyOnlyKeyValue.html" title="class in org.apache.hadoop.hbase">ByteBufferKeyOnlyKeyValue</a></code>, <code><a href="ByteBufferKeyValue.html" title="class in org.apache.hadoop.hbase">ByteBufferKeyValue</a></code>, <code><a href="IndividualBytesFieldCell.html" title="class in org.apache.hadoop.hbase">IndividualBytesFieldCell</a></code>, <code><a href="filter/KeyOnlyFilter.KeyOnlyByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase.filter">KeyOnlyFilter.KeyOnlyByteBufferExtendedCell</a></code>, <code><a href="filter/KeyOnlyFilter.KeyOnlyCell.html" title="class in org.apache.hadoop.hbase.filter">KeyOnlyFilter.KeyOnlyCell</a></code>, <code><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code>, <code><a href="KeyValue.KeyOnlyKeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue.KeyOnlyKeyValue</a></code>, <code><a href="util/MapReduceExtendedCell.html" title="class in org.apache.hadoop.hbase.util">MapReduceExtendedCell</a></code>, <code><a href="regionserver/NoTagByteBufferChunkKeyValue.html" title="class in org.apache.hadoop.hbase.regionserver">NoTagByteBufferChunkKeyValue</a></code>, <code><a href="NoTagsByteBufferKeyValue.html" title="class in org.apache.hadoop.hbase">NoTagsByteBufferKeyValue</a></code>, <code><a href="NoTagsKeyValue.html" title="class in org.apache.hadoop.hbase">NoTagsKeyValue</a></code>, <code><a href="PrivateCellUtil.EmptyByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.EmptyByteBufferExtendedCell</a></code>, <code><a href="PrivateCellUtil.EmptyCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.EmptyCell</a></code>, <code><a href="PrivateCellUtil.FirstOnRowByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowByteBufferExtendedCell</a></code>, <code><a href="PrivateCellUtil.FirstOnRowCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowCell</a></code>, <code><a href="PrivateCellUtil.FirstOnRowColByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowColByteBufferExtendedCell</a></code>, <code><a href="PrivateCellUtil.FirstOnRowColCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowColCell</a></code>, <code><a href="PrivateCellUtil.FirstOnRowColTSByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowColTSByteBufferExtendedCell</a></code>, <code><a href="PrivateCellUtil.FirstOnRowColTSCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowColTSCell</a></code>, <code><a href="PrivateCellUtil.FirstOnRowDeleteFamilyCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowDeleteFamilyCell</a></code>, <code><a href="PrivateCellUtil.LastOnRowByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.LastOnRowByteBufferExtendedCell</a></code>, <code><a href="PrivateCellUtil.LastOnRowCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.LastOnRowCell</a></code>, <code><a href="PrivateCellUtil.LastOnRowColByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.LastOnRowColByteBufferExtendedCell</a></code>, <code><a href="PrivateCellUtil.LastOnRowColCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.LastOnRowColCell</a></code>, <code><a href="PrivateCellUtil.TagRewriteByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.TagRewriteByteBufferExtendedCell</a></code>, <code><a href="PrivateCellUtil.TagRewriteCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.TagRewriteCell</a></code>, <code><a href="PrivateCellUtil.ValueAndTagRewriteByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.ValueAndTagRewriteByteBufferExtendedCell</a></code>, <code><a href="PrivateCellUtil.ValueAndTagRewriteCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.ValueAndTagRewriteCell</a></code>, <code><a href="SizeCachedByteBufferKeyValue.html" title="class in org.apache.hadoop.hbase">SizeCachedByteBufferKeyValue</a></code>, <code><a href="SizeCachedKeyValue.html" title="class in org.apache.hadoop.hbase">SizeCachedKeyValue</a></code>, <code><a href="SizeCachedNoTagsByteBufferKeyValue.html" title="class in org.apache.hadoop.hbase">SizeCachedNoTagsByteBufferKeyValue</a></code>, <code><a href="SizeCachedNoTagsKeyValue.html" title="class in org.apache.hadoop.hbase">SizeCachedNoTagsKeyValue</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Public |
| </span><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-59">Cell</a></span><span class="extends-implements"> |
| extends <a href="io/HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a></span></div> |
| <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> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="Cell.Type.html" class="type-name-link" title="enum class in org.apache.hadoop.hbase">Cell.Type</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The valid types for user to build the cell.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFamilyArray()" class="member-name-link">getFamilyArray</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Contiguous bytes composed of legal HDFS filename characters which may start at any index in the |
| containing array.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFamilyLength()" class="member-name-link">getFamilyLength</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns Number of family bytes.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFamilyOffset()" class="member-name-link">getFamilyOffset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns Array index of first family byte</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQualifierArray()" class="member-name-link">getQualifierArray</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQualifierLength()" class="member-name-link">getQualifierLength</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns Number of qualifier bytes.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getQualifierOffset()" class="member-name-link">getQualifierOffset</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns Array index of first qualifier byte</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRowArray()" class="member-name-link">getRowArray</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>short</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRowLength()" class="member-name-link">getRowLength</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns Number of row bytes.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRowOffset()" class="member-name-link">getRowOffset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns Array index of first row byte</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#getSequenceId()" class="member-name-link">getSequenceId</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">As of HBase-2.0.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSerializedSize()" class="member-name-link">getSerializedSize</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns Serialized size (defaults to include tag length if has some tags).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#getTagsArray()" class="member-name-link">getTagsArray</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">As of HBase-2.0.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#getTagsLength()" class="member-name-link">getTagsLength</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">As of HBase-2.0.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#getTagsOffset()" class="member-name-link">getTagsOffset</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">As of HBase-2.0.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTimestamp()" class="member-name-link">getTimestamp</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return a long value representing time at which this cell was "Put" into the row.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="Cell.Type.html" title="enum class in org.apache.hadoop.hbase">Cell.Type</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getType()" class="member-name-link">getType</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns the type of cell in a human readable format using <a href="Cell.Type.html" title="enum class in org.apache.hadoop.hbase"><code>Cell.Type</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>byte</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#getTypeByte()" class="member-name-link">getTypeByte</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">As of HBase-2.0.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getValueArray()" class="member-name-link">getValueArray</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getValueLength()" class="member-name-link">getValueLength</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns Number of value bytes.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getValueOffset()" class="member-name-link">getValueOffset</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns Array index of first value byte</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.io.HeapSize">Methods inherited from interface org.apache.hadoop.hbase.io.<a href="io/HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a></h3> |
| <code><a href="io/HeapSize.html#heapSize()">heapSize</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getRowArray()"> |
| <h3>getRowArray</h3> |
| <div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-69">getRowArray</a></span>()</div> |
| <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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>The array containing the row bytes.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRowOffset()"> |
| <h3>getRowOffset</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-72">getRowOffset</a></span>()</div> |
| <div class="block">Returns Array index of first row byte</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRowLength()"> |
| <h3>getRowLength</h3> |
| <div class="member-signature"><span class="return-type">short</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-75">getRowLength</a></span>()</div> |
| <div class="block">Returns Number of row bytes. Must be < rowArray.length - offset.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFamilyArray()"> |
| <h3>getFamilyArray</h3> |
| <div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-84">getFamilyArray</a></span>()</div> |
| <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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>the array containing the family bytes.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFamilyOffset()"> |
| <h3>getFamilyOffset</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-87">getFamilyOffset</a></span>()</div> |
| <div class="block">Returns Array index of first family byte</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFamilyLength()"> |
| <h3>getFamilyLength</h3> |
| <div class="member-signature"><span class="return-type">byte</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-90">getFamilyLength</a></span>()</div> |
| <div class="block">Returns Number of family bytes. Must be < familyArray.length - offset.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getQualifierArray()"> |
| <h3>getQualifierArray</h3> |
| <div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-98">getQualifierArray</a></span>()</div> |
| <div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The array containing the qualifier bytes.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getQualifierOffset()"> |
| <h3>getQualifierOffset</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-101">getQualifierOffset</a></span>()</div> |
| <div class="block">Returns Array index of first qualifier byte</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getQualifierLength()"> |
| <h3>getQualifierLength</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-104">getQualifierLength</a></span>()</div> |
| <div class="block">Returns Number of qualifier bytes. Must be < qualifierArray.length - offset.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTimestamp()"> |
| <h3>getTimestamp</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-112">getTimestamp</a></span>()</div> |
| <div class="block">Return a 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.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTypeByte()"> |
| <h3>getTypeByte</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="return-type">byte</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-120">getTypeByte</a></span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">As of HBase-2.0. Will be removed in HBase-3.0. Use <a href="#getType()"><code>getType()</code></a>.</div> |
| </div> |
| <div class="block">Return the byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSequenceId()"> |
| <h3>getSequenceId</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="return-type">long</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-133">getSequenceId</a></span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">As of HBase-2.0. Will be removed in HBase-3.0.</div> |
| </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="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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>seqId (always > 0 if exists), or 0 if it no longer exists</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValueArray()"> |
| <h3>getValueArray</h3> |
| <div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-143">getValueArray</a></span>()</div> |
| <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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>The array containing the value bytes.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValueOffset()"> |
| <h3>getValueOffset</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-146">getValueOffset</a></span>()</div> |
| <div class="block">Returns Array index of first value byte</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValueLength()"> |
| <h3>getValueLength</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-149">getValueLength</a></span>()</div> |
| <div class="block">Returns Number of value bytes. Must be < valueArray.length - offset.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSerializedSize()"> |
| <h3>getSerializedSize</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-152">getSerializedSize</a></span>()</div> |
| <div class="block">Returns Serialized size (defaults to include tag length if has some tags).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTagsArray()"> |
| <h3>getTagsArray</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-159">getTagsArray</a></span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">As of HBase-2.0. Will be removed in HBase-3.0. Tags are are now internal.</div> |
| </div> |
| <div class="block">Contiguous raw bytes representing tags that may start at any index in the containing array.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the tags byte array</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTagsOffset()"> |
| <h3>getTagsOffset</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-166">getTagsOffset</a></span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">As of HBase-2.0. Will be removed in HBase-3.0. Tags are are now internal.</div> |
| </div> |
| <div class="block">Return the first offset where the tags start in the Cell</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTagsLength()"> |
| <h3>getTagsLength</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-178">getTagsLength</a></span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">As of HBase-2.0. Will be removed in HBase-3.0. Tags are are now internal.</div> |
| </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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>the total length of the tags in the Cell.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getType()"> |
| <h3>getType</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="Cell.Type.html" title="enum class in org.apache.hadoop.hbase">Cell.Type</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/Cell.html#line-187">getType</a></span>()</div> |
| <div class="block">Returns the type of cell in a human readable format using <a href="Cell.Type.html" title="enum class in org.apache.hadoop.hbase"><code>Cell.Type</code></a>. Note : This does not |
| expose the internal types of Cells like <a href="KeyValue.Type.html#Maximum"><code>KeyValue.Type.Maximum</code></a> and |
| <a href="KeyValue.Type.html#Minimum"><code>KeyValue.Type.Minimum</code></a></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The data type this cell: one of Put, Delete, etc</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
