| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>KeyValueUtil (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, class: KeyValueUtil"> |
| <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/KeyValueUtil.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>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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="Class KeyValueUtil" class="title">Class KeyValueUtil</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.hadoop.hbase.KeyValueUtil</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-43">KeyValueUtil</a></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">static convenience methods for dealing with KeyValues and collections of KeyValues</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</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">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private static final org.slf4j.Logger</code></div> |
| <div class="col-second even-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">KeyValueUtil</a>()</code></div> |
| <div class="col-last even-row-color"> </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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab1 method-summary-table-tab4"><code>static int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#appendKeyTo(org.apache.hadoop.hbase.ExtendedCell,byte%5B%5D,int)" class="member-name-link">appendKeyTo</a><wbr>(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell, |
| byte[] output, |
| int offset)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#appendKeyTo(org.apache.hadoop.hbase.ExtendedCell,java.nio.ByteBuffer,int)" class="member-name-link">appendKeyTo</a><wbr>(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buf, |
| int offset)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#appendTo(org.apache.hadoop.hbase.ExtendedCell,java.nio.ByteBuffer,int,boolean)" class="member-name-link">appendTo</a><wbr>(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buf, |
| int offset, |
| boolean withTags)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Copy the Cell content into the passed buf in KeyValue serialization format.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#appendToByteArray(org.apache.hadoop.hbase.ExtendedCell,byte%5B%5D,int,boolean)" class="member-name-link">appendToByteArray</a><wbr>(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell, |
| byte[] output, |
| int offset, |
| boolean withTags)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">copy key and value</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#appendToByteBuffer(java.nio.ByteBuffer,org.apache.hadoop.hbase.KeyValue,boolean)" class="member-name-link">appendToByteBuffer</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> bb, |
| <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> kv, |
| boolean includeMvccVersion)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#bytesToHex(byte%5B%5D,int,int)" class="member-name-link">bytesToHex</a><wbr>(byte[] buf, |
| int offset, |
| int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkKeyValueBytes(byte%5B%5D,int,int,boolean)" class="member-name-link">checkKeyValueBytes</a><wbr>(byte[] buf, |
| int offset, |
| int length, |
| boolean withTags)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkKeyValueTagBytes(byte%5B%5D,int,int,int,int)" class="member-name-link">checkKeyValueTagBytes</a><wbr>(byte[] buf, |
| int offset, |
| int length, |
| int pos, |
| int endOffset)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#copyKeyToNewByteBuffer(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">copyKeyToNewByteBuffer</a><wbr>(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">The position will be set to the beginning of the new ByteBuffer</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#copyToNewByteArray(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">copyToNewByteArray</a><wbr>(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#copyToNewKeyValue(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">copyToNewKeyValue</a><wbr>(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">copy the cell to create a new keyvalue</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(int,java.io.DataInput)" class="member-name-link">create</a><wbr>(int length, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInput.html" title="class or interface in java.io" class="external-link">DataInput</a> in)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a KeyValue reading <code>length</code> from <code>in</code></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(java.io.DataInput)" class="member-name-link">create</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInput.html" title="class or interface in java.io" class="external-link">DataInput</a> in)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Where to read bytes from.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createFirstOnRow(byte%5B%5D)" class="member-name-link">createFirstOnRow</a><wbr>(byte[] row)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a KeyValue that is smaller than all other possible KeyValues for the given row.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createFirstOnRow(byte%5B%5D,byte%5B%5D,byte%5B%5D)" class="member-name-link">createFirstOnRow</a><wbr>(byte[] row, |
| byte[] family, |
| byte[] qualifier)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a KeyValue for the specified row, family and qualifier that would be smaller than all |
| other possible KeyValues that have the same row,family,qualifier.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createFirstOnRow(byte%5B%5D,byte%5B%5D,byte%5B%5D,byte%5B%5D)" class="member-name-link">createFirstOnRow</a><wbr>(byte[] buffer, |
| byte[] row, |
| byte[] family, |
| byte[] qualifier)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a KeyValue for the specified row, family and qualifier that would be smaller than all |
| other possible KeyValues that have the same row, family, qualifier.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createFirstOnRow(byte%5B%5D,byte%5B%5D,byte%5B%5D,long)" class="member-name-link">createFirstOnRow</a><wbr>(byte[] row, |
| byte[] f, |
| byte[] q, |
| long ts)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a KeyValue for the specified row, family and qualifier that would be smaller than all |
| other possible KeyValues that have the same row, family, qualifier.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createFirstOnRow(byte%5B%5D,int,byte%5B%5D,int,int,byte%5B%5D,int,int,byte%5B%5D,int,int)" class="member-name-link">createFirstOnRow</a><wbr>(byte[] buffer, |
| int boffset, |
| byte[] row, |
| int roffset, |
| int rlength, |
| byte[] family, |
| int foffset, |
| int flength, |
| byte[] qualifier, |
| int qoffset, |
| int qlength)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a KeyValue for the specified row, family and qualifier that would be smaller than all |
| other possible KeyValues that have the same row, family, qualifier.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createFirstOnRow(byte%5B%5D,int,int,byte%5B%5D,int,int,byte%5B%5D,int,int)" class="member-name-link">createFirstOnRow</a><wbr>(byte[] row, |
| int roffset, |
| int rlength, |
| byte[] family, |
| int foffset, |
| int flength, |
| byte[] qualifier, |
| int qoffset, |
| int qlength)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a KeyValue for the specified row, family and qualifier that would be smaller than all |
| other possible KeyValues that have the same row, family, qualifier.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createFirstOnRow(byte%5B%5D,int,short)" class="member-name-link">createFirstOnRow</a><wbr>(byte[] row, |
| int roffset, |
| short rlength)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a KeyValue that is smaller than all other possible KeyValues for the given row.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createFirstOnRow(byte%5B%5D,long)" class="member-name-link">createFirstOnRow</a><wbr>(byte[] row, |
| long ts)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a KeyValue that is smaller than all other KeyValues that are older than the passed |
| timestamp.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createKeyValueFromInputStream(java.io.InputStream,boolean)" class="member-name-link">createKeyValueFromInputStream</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> in, |
| boolean withTags)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a KeyValue reading from the raw InputStream.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createKeyValueFromKey(byte%5B%5D)" class="member-name-link">createKeyValueFromKey</a><wbr>(byte[] b)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a KeyValue made of a byte array that holds the key-only part.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createKeyValueFromKey(byte%5B%5D,int,int)" class="member-name-link">createKeyValueFromKey</a><wbr>(byte[] b, |
| int o, |
| int l)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Return a KeyValue made of a byte array that holds the key-only part.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createKeyValueFromKey(java.nio.ByteBuffer)" class="member-name-link">createKeyValueFromKey</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> bb)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Return a KeyValue made of a byte buffer that holds the key-only part.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createLastOnRow(byte%5B%5D)" class="member-name-link">createLastOnRow</a><wbr>(byte[] row)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a KeyValue that is last on the specified row id.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createLastOnRow(byte%5B%5D,int,int,byte%5B%5D,int,int,byte%5B%5D,int,int)" class="member-name-link">createLastOnRow</a><wbr>(byte[] row, |
| int roffset, |
| int rlength, |
| byte[] family, |
| int foffset, |
| int flength, |
| byte[] qualifier, |
| int qoffset, |
| int qlength)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a KeyValue for the specified row, family and qualifier that would be larger than or |
| equal to all other possible KeyValues that have the same row, family, qualifier.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#ensureKeyValue(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">ensureKeyValue</a><wbr>(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">without any replacement.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#ensureKeyValues(java.util.List)" class="member-name-link">ensureKeyValues</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>> cells)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#keyLength(short,byte,int)" class="member-name-link">keyLength</a><wbr>(short rlen, |
| byte flen, |
| int qlen)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#keyLength(org.apache.hadoop.hbase.Cell)" class="member-name-link">keyLength</a><wbr>(<a href="Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns number of bytes this cell's key part would have been used if serialized as in |
| <a href="KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#length(short,byte,int,int,int,boolean)" class="member-name-link">length</a><wbr>(short rlen, |
| byte flen, |
| int qlen, |
| int vlen, |
| int tlen, |
| boolean withTags)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">length</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#lengthWithMvccVersion(org.apache.hadoop.hbase.KeyValue,boolean)" class="member-name-link">lengthWithMvccVersion</a><wbr>(<a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> kv, |
| boolean includeMvccVersion)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#nextShallowCopy(java.nio.ByteBuffer,boolean,boolean)" class="member-name-link">nextShallowCopy</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> bb, |
| boolean includesMvccVersion, |
| boolean includesTags)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a new KeyValue object positioned in the supplied ByteBuffer and sets the ByteBuffer's |
| position to the start of the next KeyValue.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#previousKey(org.apache.hadoop.hbase.KeyValue)" class="member-name-link">previousKey</a><wbr>(<a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> in)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Decrement the timestamp.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toNewKeyCell(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">toNewKeyCell</a><wbr>(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Copies the key to a new KeyValue</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#totalLengthWithMvccVersion(java.lang.Iterable,boolean)" class="member-name-link">totalLengthWithMvccVersion</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a>> kvs, |
| boolean includeMvccVersion)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#write(org.apache.hadoop.hbase.KeyValue,java.io.DataOutput)" class="member-name-link">write</a><wbr>(<a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> kv, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataOutput.html" title="class or interface in java.io" class="external-link">DataOutput</a> out)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Write out a KeyValue in the manner in which we used to when KeyValue was a Writable.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="LOG"> |
| <h3>LOG</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-46">LOG</a></span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>KeyValueUtil</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-44">KeyValueUtil</a></span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="length(short,byte,int,int,int,boolean)"> |
| <h3>length</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-50">length</a></span><wbr><span class="parameters">(short rlen, |
| byte flen, |
| int qlen, |
| int vlen, |
| int tlen, |
| boolean withTags)</span></div> |
| <div class="block">length</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keyLength(org.apache.hadoop.hbase.Cell)"> |
| <h3>keyLength</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-62">keyLength</a></span><wbr><span class="parameters">(<a href="Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</span></div> |
| <div class="block">Returns number of bytes this cell's key part would have been used if serialized as in |
| <a href="KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a>. Key includes rowkey, family, qualifier, timestamp and type.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the key length</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keyLength(short,byte,int)"> |
| <h3>keyLength</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-66">keyLength</a></span><wbr><span class="parameters">(short rlen, |
| byte flen, |
| int qlen)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lengthWithMvccVersion(org.apache.hadoop.hbase.KeyValue,boolean)"> |
| <h3>lengthWithMvccVersion</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-70">lengthWithMvccVersion</a></span><wbr><span class="parameters">(<a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> kv, |
| boolean includeMvccVersion)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="totalLengthWithMvccVersion(java.lang.Iterable,boolean)"> |
| <h3>totalLengthWithMvccVersion</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-78">totalLengthWithMvccVersion</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a>> kvs, |
| boolean includeMvccVersion)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="copyToNewKeyValue(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>copyToNewKeyValue</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-89">copyToNewKeyValue</a></span><wbr><span class="parameters">(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell)</span></div> |
| <div class="block">copy the cell to create a new keyvalue</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="copyKeyToNewByteBuffer(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>copyKeyToNewByteBuffer</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-100">copyKeyToNewByteBuffer</a></span><wbr><span class="parameters">(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell)</span></div> |
| <div class="block">The position will be set to the beginning of the new ByteBuffer</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the Bytebuffer containing the key part of the cell</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toNewKeyCell(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>toNewKeyCell</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-111">toNewKeyCell</a></span><wbr><span class="parameters">(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell)</span></div> |
| <div class="block">Copies the key to a new KeyValue</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the KeyValue that consists only the key part of the incoming cell</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="copyToNewByteArray(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>copyToNewByteArray</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-121">copyToNewByteArray</a></span><wbr><span class="parameters">(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="appendKeyTo(org.apache.hadoop.hbase.ExtendedCell,byte[],int)"> |
| <h3>appendKeyTo</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-134">appendKeyTo</a></span><wbr><span class="parameters">(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell, |
| byte[] output, |
| int offset)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="appendToByteArray(org.apache.hadoop.hbase.ExtendedCell,byte[],int,boolean)"> |
| <h3>appendToByteArray</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-148">appendToByteArray</a></span><wbr><span class="parameters">(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell, |
| byte[] output, |
| int offset, |
| boolean withTags)</span></div> |
| <div class="block">copy key and value</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="appendTo(org.apache.hadoop.hbase.ExtendedCell,java.nio.ByteBuffer,int,boolean)"> |
| <h3>appendTo</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-165">appendTo</a></span><wbr><span class="parameters">(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buf, |
| int offset, |
| boolean withTags)</span></div> |
| <div class="block">Copy the Cell content into the passed buf in KeyValue serialization format.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="appendKeyTo(org.apache.hadoop.hbase.ExtendedCell,java.nio.ByteBuffer,int)"> |
| <h3>appendKeyTo</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-178">appendKeyTo</a></span><wbr><span class="parameters">(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buf, |
| int offset)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="appendToByteBuffer(java.nio.ByteBuffer,org.apache.hadoop.hbase.KeyValue,boolean)"> |
| <h3>appendToByteBuffer</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-189">appendToByteBuffer</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> bb, |
| <a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> kv, |
| boolean includeMvccVersion)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nextShallowCopy(java.nio.ByteBuffer,boolean,boolean)"> |
| <h3>nextShallowCopy</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-207">nextShallowCopy</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> bb, |
| boolean includesMvccVersion, |
| boolean includesTags)</span></div> |
| <div class="block">Creates a new KeyValue object positioned in the supplied ByteBuffer and sets the ByteBuffer's |
| position to the start of the next KeyValue. Does not allocate a new array or copy data.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="previousKey(org.apache.hadoop.hbase.KeyValue)"> |
| <h3>previousKey</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-241">previousKey</a></span><wbr><span class="parameters">(<a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> in)</span></div> |
| <div class="block">Decrement the timestamp. For tests (currently wasteful) Remember timestamps are sorted reverse |
| chronologically.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>previous key</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createLastOnRow(byte[],int,int,byte[],int,int,byte[],int,int)"> |
| <h3>createLastOnRow</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-253">createLastOnRow</a></span><wbr><span class="parameters">(byte[] row, |
| int roffset, |
| int rlength, |
| byte[] family, |
| int foffset, |
| int flength, |
| byte[] qualifier, |
| int qoffset, |
| int qlength)</span></div> |
| <div class="block">Create a KeyValue for the specified row, family and qualifier that would be larger than or |
| equal to all other possible KeyValues that have the same row, family, qualifier. Used for |
| reseeking. Should NEVER be returned to a client. row key row offset row length family name |
| family offset family length column qualifier qualifier offset qualifier length</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Last possible key on passed row, family, qualifier.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createFirstOnRow(byte[],int,short)"> |
| <h3>createFirstOnRow</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-266">createFirstOnRow</a></span><wbr><span class="parameters">(byte[] row, |
| int roffset, |
| short rlength)</span></div> |
| <div class="block">Create a KeyValue that is smaller than all other possible KeyValues for the given row. That is |
| any (valid) KeyValue on 'row' would sort _after_ the result.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>row</code> - - row key (arbitrary byte array)</dd> |
| <dt>Returns:</dt> |
| <dd>First possible KeyValue on passed <code>row</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createLastOnRow(byte[])"> |
| <h3>createLastOnRow</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-277">createLastOnRow</a></span><wbr><span class="parameters">(byte[] row)</span></div> |
| <div class="block">Creates a KeyValue that is last on the specified row id. That is, every other possible KeyValue |
| for the given row would compareTo() less than the result of this call.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>row</code> - row key</dd> |
| <dt>Returns:</dt> |
| <dd>Last possible KeyValue on passed <code>row</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createFirstOnRow(byte[])"> |
| <h3>createFirstOnRow</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-287">createFirstOnRow</a></span><wbr><span class="parameters">(byte[] row)</span></div> |
| <div class="block">Create a KeyValue that is smaller than all other possible KeyValues for the given row. That is |
| any (valid) KeyValue on 'row' would sort _after_ the result.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>row</code> - - row key (arbitrary byte array)</dd> |
| <dt>Returns:</dt> |
| <dd>First possible KeyValue on passed <code>row</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createFirstOnRow(byte[],long)"> |
| <h3>createFirstOnRow</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-298">createFirstOnRow</a></span><wbr><span class="parameters">(byte[] row, |
| long ts)</span></div> |
| <div class="block">Creates a KeyValue that is smaller than all other KeyValues that are older than the passed |
| timestamp.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>row</code> - - row key (arbitrary byte array)</dd> |
| <dd><code>ts</code> - - timestamp</dd> |
| <dt>Returns:</dt> |
| <dd>First possible key on passed <code>row</code> and timestamp.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createFirstOnRow(byte[],byte[],byte[])"> |
| <h3>createFirstOnRow</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-310">createFirstOnRow</a></span><wbr><span class="parameters">(byte[] row, |
| byte[] family, |
| byte[] qualifier)</span></div> |
| <div class="block">Create a KeyValue for the specified row, family and qualifier that would be smaller than all |
| other possible KeyValues that have the same row,family,qualifier. Used for seeking.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>row</code> - - row key (arbitrary byte array)</dd> |
| <dd><code>family</code> - - family name</dd> |
| <dd><code>qualifier</code> - - column qualifier</dd> |
| <dt>Returns:</dt> |
| <dd>First possible key on passed <code>row</code>, and column.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createFirstOnRow(byte[],byte[],byte[],long)"> |
| <h3>createFirstOnRow</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-324">createFirstOnRow</a></span><wbr><span class="parameters">(byte[] row, |
| byte[] f, |
| byte[] q, |
| long ts)</span></div> |
| <div class="block">Create a KeyValue for the specified row, family and qualifier that would be smaller than all |
| other possible KeyValues that have the same row, family, qualifier. Used for seeking.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>row</code> - - row key (arbitrary byte array)</dd> |
| <dd><code>f</code> - - family name</dd> |
| <dd><code>q</code> - - column qualifier</dd> |
| <dd><code>ts</code> - - timestamp</dd> |
| <dt>Returns:</dt> |
| <dd>First possible key on passed <code>row</code>, column and timestamp</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createFirstOnRow(byte[],int,int,byte[],int,int,byte[],int,int)"> |
| <h3>createFirstOnRow</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-343">createFirstOnRow</a></span><wbr><span class="parameters">(byte[] row, |
| int roffset, |
| int rlength, |
| byte[] family, |
| int foffset, |
| int flength, |
| byte[] qualifier, |
| int qoffset, |
| int qlength)</span></div> |
| <div class="block">Create a KeyValue for the specified row, family and qualifier that would be smaller than all |
| other possible KeyValues that have the same row, family, qualifier. Used for seeking.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>row</code> - row key</dd> |
| <dd><code>roffset</code> - row offset</dd> |
| <dd><code>rlength</code> - row length</dd> |
| <dd><code>family</code> - family name</dd> |
| <dd><code>foffset</code> - family offset</dd> |
| <dd><code>flength</code> - family length</dd> |
| <dd><code>qualifier</code> - column qualifier</dd> |
| <dd><code>qoffset</code> - qualifier offset</dd> |
| <dd><code>qlength</code> - qualifier length</dd> |
| <dt>Returns:</dt> |
| <dd>First possible key on passed Row, Family, Qualifier.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createFirstOnRow(byte[],byte[],byte[],byte[])"> |
| <h3>createFirstOnRow</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-362">createFirstOnRow</a></span><wbr><span class="parameters">(byte[] buffer, |
| byte[] row, |
| byte[] family, |
| byte[] qualifier)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Create a KeyValue for the specified row, family and qualifier that would be smaller than all |
| other possible KeyValues that have the same row, family, qualifier. Used for seeking.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - the buffer to use for the new <code>KeyValue</code> object</dd> |
| <dd><code>row</code> - the value key</dd> |
| <dd><code>family</code> - family name</dd> |
| <dd><code>qualifier</code> - column qualifier</dd> |
| <dt>Returns:</dt> |
| <dd>First possible key on passed Row, Family, Qualifier.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - The resulting <code>KeyValue</code> object would be larger |
| than the provided buffer or than |
| <code>Integer.MAX_VALUE</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createFirstOnRow(byte[],int,byte[],int,int,byte[],int,int,byte[],int,int)"> |
| <h3>createFirstOnRow</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-387">createFirstOnRow</a></span><wbr><span class="parameters">(byte[] buffer, |
| int boffset, |
| byte[] row, |
| int roffset, |
| int rlength, |
| byte[] family, |
| int foffset, |
| int flength, |
| byte[] qualifier, |
| int qoffset, |
| int qlength)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div> |
| <div class="block">Create a KeyValue for the specified row, family and qualifier that would be smaller than all |
| other possible KeyValues that have the same row, family, qualifier. Used for seeking.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - the buffer to use for the new <code>KeyValue</code> object</dd> |
| <dd><code>boffset</code> - buffer offset</dd> |
| <dd><code>row</code> - the value key</dd> |
| <dd><code>roffset</code> - row offset</dd> |
| <dd><code>rlength</code> - row length</dd> |
| <dd><code>family</code> - family name</dd> |
| <dd><code>foffset</code> - family offset</dd> |
| <dd><code>flength</code> - family length</dd> |
| <dd><code>qualifier</code> - column qualifier</dd> |
| <dd><code>qoffset</code> - qualifier offset</dd> |
| <dd><code>qlength</code> - qualifier length</dd> |
| <dt>Returns:</dt> |
| <dd>First possible key on passed Row, Family, Qualifier.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - The resulting <code>KeyValue</code> object would be larger |
| than the provided buffer or than |
| <code>Integer.MAX_VALUE</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureKeyValue(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>ensureKeyValue</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="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-417">ensureKeyValue</a></span><wbr><span class="parameters">(<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> cell)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">without any replacement.</div> |
| </div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>cell</code> if it is an object of class <a href="KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a> else we will return a |
| new <a href="KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a> instance made from <code>cell</code> Note: Even if the cell is an |
| object of any of the subclass of <a href="KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a>, we will create a new |
| <a href="KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a> object wrapping same buffer. This API is used only with MR based tools |
| which expect the type to be exactly KeyValue. That is the reason for doing this way.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureKeyValues(java.util.List)"> |
| <h3>ensureKeyValues</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="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-434">ensureKeyValues</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>> cells)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="write(org.apache.hadoop.hbase.KeyValue,java.io.DataOutput)"> |
| <h3>write</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-450">write</a></span><wbr><span class="parameters">(<a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> kv, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataOutput.html" title="class or interface in java.io" class="external-link">DataOutput</a> out)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Write out a KeyValue in the manner in which we used to when KeyValue was a Writable.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Length written on stream</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#create(java.io.DataInput)"><code>for the inverse function</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="bytesToHex(byte[],int,int)"> |
| <h3>bytesToHex</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-460">bytesToHex</a></span><wbr><span class="parameters">(byte[] buf, |
| int offset, |
| int length)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkKeyValueBytes(byte[],int,int,boolean)"> |
| <h3>checkKeyValueBytes</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-465">checkKeyValueBytes</a></span><wbr><span class="parameters">(byte[] buf, |
| int offset, |
| int length, |
| boolean withTags)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkKeyValueTagBytes(byte[],int,int,int,int)"> |
| <h3>checkKeyValueTagBytes</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-598">checkKeyValueTagBytes</a></span><wbr><span class="parameters">(byte[] buf, |
| int offset, |
| int length, |
| int pos, |
| int endOffset)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createKeyValueFromInputStream(java.io.InputStream,boolean)"> |
| <h3>createKeyValueFromInputStream</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-644">createKeyValueFromInputStream</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> in, |
| boolean withTags)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Create a KeyValue reading from the raw InputStream. Named |
| <code>createKeyValueFromInputStream</code> so doesn't clash with <a href="#create(java.io.DataInput)"><code>create(DataInput)</code></a></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>in</code> - inputStream to read.</dd> |
| <dd><code>withTags</code> - whether the keyvalue should include tags are not</dd> |
| <dt>Returns:</dt> |
| <dd>Created KeyValue OR if we find a length of zero, we will return null which can be |
| useful marking a stream as done.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createKeyValueFromKey(byte[])"> |
| <h3>createKeyValueFromKey</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-669">createKeyValueFromKey</a></span><wbr><span class="parameters">(byte[] b)</span></div> |
| <div class="block">Returns a KeyValue made of a byte array that holds the key-only part. Needed to convert hfile |
| index members to KeyValues.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createKeyValueFromKey(java.nio.ByteBuffer)"> |
| <h3>createKeyValueFromKey</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-677">createKeyValueFromKey</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> bb)</span></div> |
| <div class="block">Return a KeyValue made of a byte buffer that holds the key-only part. Needed to convert hfile |
| index members to KeyValues.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createKeyValueFromKey(byte[],int,int)"> |
| <h3>createKeyValueFromKey</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-685">createKeyValueFromKey</a></span><wbr><span class="parameters">(byte[] b, |
| int o, |
| int l)</span></div> |
| <div class="block">Return a KeyValue made of a byte array that holds the key-only part. Needed to convert hfile |
| index members to KeyValues.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(java.io.DataInput)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-699">create</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInput.html" title="class or interface in java.io" class="external-link">DataInput</a> in)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Where to read bytes from. Creates a byte array to hold the KeyValue backing bytes copied from |
| the steam.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>KeyValue created by deserializing from <code>in</code> OR if we find a length of zero, |
| we will return null which can be useful marking a stream as done.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(int,java.io.DataInput)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/KeyValueUtil.html#line-708">create</a></span><wbr><span class="parameters">(int length, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInput.html" title="class or interface in java.io" class="external-link">DataInput</a> in)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Create a KeyValue reading <code>length</code> from <code>in</code></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Created KeyValue OR if we find a length of zero, we will return null which can be |
| useful marking a stream as done.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></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> |