| <!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>ExtendedCell (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="ExtendedCell (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":18,"i1":18,"i2":6,"i3":18,"i4":18,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":18,"i13":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/ExtendedCell.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/ExecutorStatusChore.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/hbase/ExtendedCellBuilder.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/ExtendedCell.html" target="_top">Frames</a></li> |
| <li><a href="ExtendedCell.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><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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 ExtendedCell" class="title">Interface ExtendedCell</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>, <a href="../../../../org/apache/hadoop/hbase/io/HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/hadoop/hbase/io/encoding/BufferedDataBlockEncoder.OffheapDecodedExtendedCell.html" title="class in org.apache.hadoop.hbase.io.encoding">BufferedDataBlockEncoder.OffheapDecodedExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/io/encoding/BufferedDataBlockEncoder.OnheapDecodedCell.html" title="class in org.apache.hadoop.hbase.io.encoding">BufferedDataBlockEncoder.OnheapDecodedCell</a>, <a href="../../../../org/apache/hadoop/hbase/regionserver/ByteBufferChunkKeyValue.html" title="class in org.apache.hadoop.hbase.regionserver">ByteBufferChunkKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/ByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">ByteBufferExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/ByteBufferKeyOnlyKeyValue.html" title="class in org.apache.hadoop.hbase">ByteBufferKeyOnlyKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/ByteBufferKeyValue.html" title="class in org.apache.hadoop.hbase">ByteBufferKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/IndividualBytesFieldCell.html" title="class in org.apache.hadoop.hbase">IndividualBytesFieldCell</a>, <a href="../../../../org/apache/hadoop/hbase/filter/KeyOnlyFilter.KeyOnlyByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase.filter">KeyOnlyFilter.KeyOnlyByteBufferExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/KeyValue.KeyOnlyKeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue.KeyOnlyKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/util/MapReduceExtendedCell.html" title="class in org.apache.hadoop.hbase.util">MapReduceExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/client/Mutation.CellWrapper.html" title="class in org.apache.hadoop.hbase.client">Mutation.CellWrapper</a>, <a href="../../../../org/apache/hadoop/hbase/regionserver/NoTagByteBufferChunkKeyValue.html" title="class in org.apache.hadoop.hbase.regionserver">NoTagByteBufferChunkKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/NoTagsByteBufferKeyValue.html" title="class in org.apache.hadoop.hbase">NoTagsByteBufferKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/NoTagsKeyValue.html" title="class in org.apache.hadoop.hbase">NoTagsKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.EmptyByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.EmptyByteBufferExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.EmptyCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.EmptyCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.FirstOnRowByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowByteBufferExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.FirstOnRowCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.FirstOnRowColByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowColByteBufferExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.FirstOnRowColCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowColCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.FirstOnRowColTSByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowColTSByteBufferExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.FirstOnRowColTSCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowColTSCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.FirstOnRowDeleteFamilyCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.FirstOnRowDeleteFamilyCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.LastOnRowByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.LastOnRowByteBufferExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.LastOnRowCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.LastOnRowCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.LastOnRowColByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.LastOnRowColByteBufferExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.LastOnRowColCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.LastOnRowColCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.TagRewriteByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.TagRewriteByteBufferExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.TagRewriteCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.TagRewriteCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.ValueAndTagRewriteByteBufferExtendedCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.ValueAndTagRewriteByteBufferExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.ValueAndTagRewriteCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.ValueAndTagRewriteCell</a>, <a href="../../../../org/apache/hadoop/hbase/SizeCachedByteBufferKeyValue.html" title="class in org.apache.hadoop.hbase">SizeCachedByteBufferKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/SizeCachedKeyValue.html" title="class in org.apache.hadoop.hbase">SizeCachedKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/SizeCachedNoTagsByteBufferKeyValue.html" title="class in org.apache.hadoop.hbase">SizeCachedNoTagsByteBufferKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/SizeCachedNoTagsKeyValue.html" title="class in org.apache.hadoop.hbase">SizeCachedNoTagsKeyValue</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| public interface <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.33">ExtendedCell</a> |
| extends <a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a>, <a href="../../../../org/apache/hadoop/hbase/io/HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a></pre> |
| <div class="block">Extension to <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase"><code>Cell</code></a> with server side required functions. Server side Cell implementations |
| must implement this.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.hbase.Cell"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></h3> |
| <code><a href="../../../../org/apache/hadoop/hbase/Cell.Type.html" title="enum in org.apache.hadoop.hbase">Cell.Type</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#CELL_NOT_BASED_ON_CHUNK">CELL_NOT_BASED_ON_CHUNK</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.RawCell"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a></h3> |
| <code><a href="../../../../org/apache/hadoop/hbase/RawCell.html#MAX_TAGS_LENGTH">MAX_TAGS_LENGTH</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== 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></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>default <a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#deepClone--">deepClone</a></span>()</code> |
| <div class="block">Does a deep copy of the contents to a new memory area and returns it as a new cell.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#getChunkId--">getChunkId</a></span>()</code> |
| <div class="block">Extracts the id of the backing bytebuffer of this cell if it was obtained from fixed sized |
| chunks as in case of MemstoreLAB</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#getSequenceId--">getSequenceId</a></span>()</code> |
| <div class="block">A region-specific unique monotonically increasing sequence ID given to each Cell.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#getSerializedSize--">getSerializedSize</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>default int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#getSerializedSize-boolean-">getSerializedSize</a></span>(boolean withTags)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.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="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.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="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#getTagsOffset--">getTagsOffset</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>byte</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#getTypeByte--">getTypeByte</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#setSequenceId-long-">setSequenceId</a></span>(long seqId)</code> |
| <div class="block">Sets with the given seqId.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#setTimestamp-byte:A-">setTimestamp</a></span>(byte[] ts)</code> |
| <div class="block">Sets with the given timestamp.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#setTimestamp-long-">setTimestamp</a></span>(long ts)</code> |
| <div class="block">Sets with the given timestamp.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#write-java.nio.ByteBuffer-int-">write</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> buf, |
| int offset)</code> |
| <div class="block">Write this Cell into the given buf's offset in a <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a> format.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>default int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#write-java.io.OutputStream-boolean-">write</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out, |
| boolean withTags)</code> |
| <div class="block">Write this cell to an OutputStream in a <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a> format.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.RawCell"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a></h3> |
| <code><a href="../../../../org/apache/hadoop/hbase/RawCell.html#checkForTagsLength-int-">checkForTagsLength</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html#cloneTags--">cloneTags</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html#createCell-org.apache.hadoop.hbase.Cell-java.util.List-">createCell</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html#getTag-byte-">getTag</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html#getTags--">getTags</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.Cell"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></h3> |
| <code><a href="../../../../org/apache/hadoop/hbase/Cell.html#getFamilyArray--">getFamilyArray</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getFamilyLength--">getFamilyLength</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getFamilyOffset--">getFamilyOffset</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getQualifierArray--">getQualifierArray</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getQualifierLength--">getQualifierLength</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getQualifierOffset--">getQualifierOffset</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getRowArray--">getRowArray</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getRowLength--">getRowLength</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getRowOffset--">getRowOffset</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getTimestamp--">getTimestamp</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getType--">getType</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getValueArray--">getValueArray</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getValueLength--">getValueLength</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getValueOffset--">getValueOffset</a></code></li> |
| </ul> |
| <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.<a href="../../../../org/apache/hadoop/hbase/io/HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a></h3> |
| <code><a href="../../../../org/apache/hadoop/hbase/io/HeapSize.html#heapSize--">heapSize</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="CELL_NOT_BASED_ON_CHUNK"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CELL_NOT_BASED_ON_CHUNK</h4> |
| <pre>static final int <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.34">CELL_NOT_BASED_ON_CHUNK</a></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.ExtendedCell.CELL_NOT_BASED_ON_CHUNK">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="write-java.io.OutputStream-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>default int <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.49">write</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out, |
| boolean withTags) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Write this cell to an OutputStream in a <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a> format. |
| <br> KeyValue format <br> |
| <code><4 bytes keylength> <4 bytes valuelength> <2 bytes rowlength> |
| <row> <1 byte columnfamilylength> <columnfamily> <columnqualifier> |
| <8 bytes timestamp> <1 byte keytype> <value> <2 bytes tagslength> |
| <tags></code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>out</code> - Stream to which cell has to be written</dd> |
| <dd><code>withTags</code> - Whether to write tags.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>how many bytes are written.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSerializedSize-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSerializedSize</h4> |
| <pre>default int <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.85">getSerializedSize</a>(boolean withTags)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>withTags</code> - Whether to write tags.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Bytes count required to serialize this Cell in a <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a> format. |
| <br> KeyValue format <br> |
| <code><4 bytes keylength> <4 bytes valuelength> <2 bytes rowlength> |
| <row> <1 byte columnfamilylength> <columnfamily> <columnqualifier> |
| <8 bytes timestamp> <1 byte keytype> <value> <2 bytes tagslength> |
| <tags></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSerializedSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSerializedSize</h4> |
| <pre>default int <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.94">getSerializedSize</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/hbase/Cell.html#getSerializedSize--">getSerializedSize</a></code> in interface <code><a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Serialized size (defaults to include tag length).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="write-java.nio.ByteBuffer-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>default void <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.103">write</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> buf, |
| int offset)</pre> |
| <div class="block">Write this Cell into the given buf's offset in a <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a> format.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buf</code> - The buffer where to write the Cell.</dd> |
| <dd><code>offset</code> - The offset within buffer, to write the Cell.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deepClone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deepClone</h4> |
| <pre>default <a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.111">deepClone</a>()</pre> |
| <div class="block">Does a deep copy of the contents to a new memory area and returns it as a new cell.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The deep cloned cell</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getChunkId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChunkId</h4> |
| <pre>default int <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.122">getChunkId</a>()</pre> |
| <div class="block">Extracts the id of the backing bytebuffer of this cell if it was obtained from fixed sized |
| chunks as in case of MemstoreLAB</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the chunk id if the cell is backed by fixed sized Chunks, else return |
| <a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#CELL_NOT_BASED_ON_CHUNK"><code>CELL_NOT_BASED_ON_CHUNK</code></a>; i.e. -1.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSequenceId-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSequenceId</h4> |
| <pre>void <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.130">setSequenceId</a>(long seqId) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Sets with the given seqId.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>seqId</code> - sequence ID</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTimestamp-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTimestamp</h4> |
| <pre>void <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.136">setTimestamp</a>(long ts) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Sets with the given timestamp.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ts</code> - timestamp</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTimestamp-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTimestamp</h4> |
| <pre>void <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.142">setTimestamp</a>(byte[] ts) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Sets with the given timestamp.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ts</code> - buffer containing the timestamp value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSequenceId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSequenceId</h4> |
| <pre>long <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.151">getSequenceId</a>()</pre> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/hbase/Cell.html#getSequenceId--">getSequenceId</a></code> in interface <code><a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></dd> |
| <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="getTagsArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTagsArray</h4> |
| <pre>byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.157">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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/hbase/Cell.html#getTagsArray--">getTagsArray</a></code> in interface <code><a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></dd> |
| <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>int <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.162">getTagsOffset</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/hbase/Cell.html#getTagsOffset--">getTagsOffset</a></code> in interface <code><a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></dd> |
| <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>int <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.172">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 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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/hbase/Cell.html#getTagsLength--">getTagsLength</a></code> in interface <code><a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the total length of the tags in the Cell.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTypeByte--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getTypeByte</h4> |
| <pre>byte <a href="../../../../src-html/org/apache/hadoop/hbase/ExtendedCell.html#line.177">getTypeByte</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/hadoop/hbase/Cell.html#getTypeByte--">getTypeByte</a></code> in interface <code><a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></dd> |
| <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> |
| </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/ExtendedCell.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/ExecutorStatusChore.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/hbase/ExtendedCellBuilder.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/ExtendedCell.html" target="_top">Frames</a></li> |
| <li><a href="ExtendedCell.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><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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> |
