| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>PositionedByteRange (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.util, interface: PositionedByteRange"> |
| <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/PositionedByteRange.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.util</a></div> |
| <h1 title="Interface PositionedByteRange" class="title">Interface PositionedByteRange</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a>></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractPositionedByteRange.html" title="class in org.apache.hadoop.hbase.util">AbstractPositionedByteRange</a></code>, <code><a href="SimplePositionedByteRange.html" title="class in org.apache.hadoop.hbase.util">SimplePositionedByteRange</a></code>, <code><a href="SimplePositionedMutableByteRange.html" title="class in org.apache.hadoop.hbase.util">SimplePositionedMutableByteRange</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Public |
| </span><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-33">PositionedByteRange</a></span><span class="extends-implements"> |
| extends <a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></span></div> |
| <div class="block"><p> |
| Extends <a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util"><code>ByteRange</code></a> with additional methods to support tracking a consumers position within |
| the viewport. The API is extended with methods <a href="#get()"><code>get()</code></a> and <a href="#put(byte)"><code>put(byte)</code></a> for |
| interacting with the backing array from the current position forward. This frees the caller from |
| managing their own index into the array. |
| </p> |
| <p> |
| Designed to be a slimmed-down, mutable alternative to <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"><code>ByteBuffer</code></a>. |
| </p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#deepCopy()" class="member-name-link">deepCopy</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Create a new <code>ByteRange</code> with new backing byte[] containing a copy of the content from |
| <code>this</code> range's window.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#get()" class="member-name-link">get</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Retrieve the next byte from this range.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#get(byte%5B%5D)" class="member-name-link">get</a><wbr>(byte[] dst)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Fill <code>dst</code> with bytes from the range, starting from <code>position</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#get(byte%5B%5D,int,int)" class="member-name-link">get</a><wbr>(byte[] dst, |
| int offset, |
| int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Fill <code>dst</code> with bytes from the range, starting from the current <code>position</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#get(int,byte%5B%5D)" class="member-name-link">get</a><wbr>(int index, |
| byte[] dst)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Fill <code>dst</code> with bytes from the range, starting from <code>index</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#get(int,byte%5B%5D,int,int)" class="member-name-link">get</a><wbr>(int index, |
| byte[] dst, |
| int offset, |
| int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Fill <code>dst</code> with bytes from the range, starting from <code>index</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getInt()" class="member-name-link">getInt</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Retrieve the next int value from this range.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLimit()" class="member-name-link">getLimit</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return the current limit</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLong()" class="member-name-link">getLong</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Retrieve the next long value from this range.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPosition()" class="member-name-link">getPosition</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">The current <code>position</code> marker.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRemaining()" class="member-name-link">getRemaining</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">The number of bytes remaining between position and the end of the range.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>short</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getShort()" class="member-name-link">getShort</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Retrieve the next short value from this range.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getVLong()" class="member-name-link">getVLong</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Retrieve the next long value, which is stored as VLong, from this range</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#peek()" class="member-name-link">peek</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Retrieve the next byte from this range without incrementing position.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#put(byte)" class="member-name-link">put</a><wbr>(byte val)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Store <code>val</code> at the next position in this range.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#put(byte%5B%5D)" class="member-name-link">put</a><wbr>(byte[] val)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Store the content of <code>val</code> in this range, starting at the next position.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#put(byte%5B%5D,int,int)" class="member-name-link">put</a><wbr>(byte[] val, |
| int offset, |
| int length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Store <code>length</code> bytes from <code>val</code> into this range.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#put(int,byte)" class="member-name-link">put</a><wbr>(int index, |
| byte val)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Store <code>val</code> at <code>index</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#put(int,byte%5B%5D)" class="member-name-link">put</a><wbr>(int index, |
| byte[] val)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Store <code>val</code> at <code>index</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#put(int,byte%5B%5D,int,int)" class="member-name-link">put</a><wbr>(int index, |
| byte[] val, |
| int offset, |
| int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Store <code>length</code> bytes from <code>val</code> into this range, starting at <code>index</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#putInt(int)" class="member-name-link">putInt</a><wbr>(int val)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Store int <code>val</code> at the next position in this range.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#putInt(int,int)" class="member-name-link">putInt</a><wbr>(int index, |
| int val)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Store the int value at <code>index</code></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#putLong(int,long)" class="member-name-link">putLong</a><wbr>(int index, |
| long val)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Store the long value at <code>index</code></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#putLong(long)" class="member-name-link">putLong</a><wbr>(long val)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Store long <code>val</code> at the next position in this range.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#putShort(int,short)" class="member-name-link">putShort</a><wbr>(int index, |
| short val)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Store the short value at <code>index</code></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#putShort(short)" class="member-name-link">putShort</a><wbr>(short val)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Store short <code>val</code> at the next position in this range.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#putVLong(long)" class="member-name-link">putVLong</a><wbr>(long val)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Store the long <code>val</code> at the next position as a VLong</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#set(byte%5B%5D)" class="member-name-link">set</a><wbr>(byte[] bytes)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reuse this <code>ByteRange</code> over a new byte[].</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#set(byte%5B%5D,int,int)" class="member-name-link">set</a><wbr>(byte[] bytes, |
| int offset, |
| int length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reuse this <code>ByteRange</code> over a new byte[].</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#set(int)" class="member-name-link">set</a><wbr>(int capacity)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Reuse this <code>ByteRange</code> over a new byte[].</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLength(int)" class="member-name-link">setLength</a><wbr>(int length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Update the length of this range.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setLimit(int)" class="member-name-link">setLimit</a><wbr>(int limit)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Limits the byte range upto a specified value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setOffset(int)" class="member-name-link">setOffset</a><wbr>(int offset)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Update the beginning of this range.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setPosition(int)" class="member-name-link">setPosition</a><wbr>(int position)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Update the <code>position</code> index.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#shallowCopy()" class="member-name-link">shallowCopy</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Create a new <code>ByteRange</code> that points at this range's byte[].</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#shallowCopySubRange(int,int)" class="member-name-link">shallowCopySubRange</a><wbr>(int innerOffset, |
| int copyLength)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Create a new <code>ByteRange</code> that points at this range's byte[].</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#unset()" class="member-name-link">unset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Nullifies this ByteRange.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.util.ByteRange">Methods inherited from interface org.apache.hadoop.hbase.util.<a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></h3> |
| <code><a href="ByteRange.html#deepCopySubRangeTo(int,int,byte%5B%5D,int)">deepCopySubRangeTo</a>, <a href="ByteRange.html#deepCopyTo(byte%5B%5D,int)">deepCopyTo</a>, <a href="ByteRange.html#deepCopyToNewArray()">deepCopyToNewArray</a>, <a href="ByteRange.html#get(int)">get</a>, <a href="ByteRange.html#getBytes()">getBytes</a>, <a href="ByteRange.html#getInt(int)">getInt</a>, <a href="ByteRange.html#getLength()">getLength</a>, <a href="ByteRange.html#getLong(int)">getLong</a>, <a href="ByteRange.html#getOffset()">getOffset</a>, <a href="ByteRange.html#getShort(int)">getShort</a>, <a href="ByteRange.html#getVLong(int)">getVLong</a>, <a href="ByteRange.html#isEmpty()">isEmpty</a>, <a href="ByteRange.html#putVLong(int,long)">putVLong</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Comparable">Methods inherited from interface java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html#compareTo(T)" title="class or interface in java.lang" class="external-link">compareTo</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getPosition()"> |
| <h3>getPosition</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-42">getPosition</a></span>()</div> |
| <div class="block">The current <code>position</code> marker. This valuae is 0-indexed, relative to the beginning of the |
| range.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPosition(int)"> |
| <h3>setPosition</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-49">setPosition</a></span><wbr><span class="parameters">(int position)</span></div> |
| <div class="block">Update the <code>position</code> index. May not be greater than <code>length</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>position</code> - the new position in this range.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemaining()"> |
| <h3>getRemaining</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-54">getRemaining</a></span>()</div> |
| <div class="block">The number of bytes remaining between position and the end of the range.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="peek()"> |
| <h3>peek</h3> |
| <div class="member-signature"><span class="return-type">byte</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-59">peek</a></span>()</div> |
| <div class="block">Retrieve the next byte from this range without incrementing position.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get()"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="return-type">byte</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-64">get</a></span>()</div> |
| <div class="block">Retrieve the next byte from this range.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getShort()"> |
| <h3>getShort</h3> |
| <div class="member-signature"><span class="return-type">short</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-69">getShort</a></span>()</div> |
| <div class="block">Retrieve the next short value from this range.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInt()"> |
| <h3>getInt</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-74">getInt</a></span>()</div> |
| <div class="block">Retrieve the next int value from this range.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLong()"> |
| <h3>getLong</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-79">getLong</a></span>()</div> |
| <div class="block">Retrieve the next long value from this range.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVLong()"> |
| <h3>getVLong</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-85">getVLong</a></span>()</div> |
| <div class="block">Retrieve the next long value, which is stored as VLong, from this range</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the long value which is stored as VLong</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(byte[])"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-93">get</a></span><wbr><span class="parameters">(byte[] dst)</span></div> |
| <div class="block">Fill <code>dst</code> with bytes from the range, starting from <code>position</code>. This range's |
| <code>position</code> is incremented by the length of <code>dst</code>, the number of bytes copied.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dst</code> - the destination of the copy.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(byte[],int,int)"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-104">get</a></span><wbr><span class="parameters">(byte[] dst, |
| int offset, |
| int length)</span></div> |
| <div class="block">Fill <code>dst</code> with bytes from the range, starting from the current <code>position</code>. |
| <code>length</code> bytes are copied into <code>dst</code>, starting at <code>offset</code>. This range's |
| <code>position</code> is incremented by the number of bytes copied.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dst</code> - the destination of the copy.</dd> |
| <dd><code>offset</code> - the offset into <code>dst</code> to start the copy.</dd> |
| <dd><code>length</code> - the number of bytes to copy into <code>dst</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(byte)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-111">put</a></span><wbr><span class="parameters">(byte val)</span></div> |
| <div class="block">Store <code>val</code> at the next position in this range.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>val</code> - the new value.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putShort(short)"> |
| <h3>putShort</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-118">putShort</a></span><wbr><span class="parameters">(short val)</span></div> |
| <div class="block">Store short <code>val</code> at the next position in this range.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>val</code> - the new value.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putInt(int)"> |
| <h3>putInt</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-125">putInt</a></span><wbr><span class="parameters">(int val)</span></div> |
| <div class="block">Store int <code>val</code> at the next position in this range.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>val</code> - the new value.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putLong(long)"> |
| <h3>putLong</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-132">putLong</a></span><wbr><span class="parameters">(long val)</span></div> |
| <div class="block">Store long <code>val</code> at the next position in this range.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>val</code> - the new value.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putVLong(long)"> |
| <h3>putVLong</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-139">putVLong</a></span><wbr><span class="parameters">(long val)</span></div> |
| <div class="block">Store the long <code>val</code> at the next position as a VLong</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>val</code> - the value to store</dd> |
| <dt>Returns:</dt> |
| <dd>number of bytes written</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(byte[])"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-146">put</a></span><wbr><span class="parameters">(byte[] val)</span></div> |
| <div class="block">Store the content of <code>val</code> in this range, starting at the next position.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>val</code> - the new value.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(byte[],int,int)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-156">put</a></span><wbr><span class="parameters">(byte[] val, |
| int offset, |
| int length)</span></div> |
| <div class="block">Store <code>length</code> bytes from <code>val</code> into this range. Bytes from <code>val</code> are copied |
| starting at <code>offset</code> into the range, starting at the current position.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>val</code> - the new value.</dd> |
| <dd><code>offset</code> - the offset in <code>val</code> from which to start copying.</dd> |
| <dd><code>length</code> - the number of bytes to copy from <code>val</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLimit(int)"> |
| <h3>setLimit</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-161">setLimit</a></span><wbr><span class="parameters">(int limit)</span></div> |
| <div class="block">Limits the byte range upto a specified value. Limit cannot be greater than capacity</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLimit()"> |
| <h3>getLimit</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-166">getLimit</a></span>()</div> |
| <div class="block">Return the current limit</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unset()"> |
| <h3>unset</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-170">unset</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#unset()">ByteRange</a></code></span></div> |
| <div class="block">Nullifies this ByteRange. That is, it becomes a husk, being a range over no byte[] whatsoever.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#unset()">unset</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="set(int)"> |
| <h3>set</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-173">set</a></span><wbr><span class="parameters">(int capacity)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#set(int)">ByteRange</a></code></span></div> |
| <div class="block">Reuse this <code>ByteRange</code> over a new byte[]. <code>offset</code> is set to 0 and <code>length</code> |
| is set to <code>capacity</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#set(int)">set</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>capacity</code> - the size of a new byte[].</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="set(byte[])"> |
| <h3>set</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-176">set</a></span><wbr><span class="parameters">(byte[] bytes)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#set(byte%5B%5D)">ByteRange</a></code></span></div> |
| <div class="block">Reuse this <code>ByteRange</code> over a new byte[]. <code>offset</code> is set to 0 and <code>length</code> |
| is set to <code>bytes.length</code>. A null <code>bytes</code> IS supported, in which case this method |
| will behave equivalently to <a href="ByteRange.html#unset()"><code>ByteRange.unset()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#set(byte%5B%5D)">set</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>bytes</code> - the array to wrap.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="set(byte[],int,int)"> |
| <h3>set</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-179">set</a></span><wbr><span class="parameters">(byte[] bytes, |
| int offset, |
| int length)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#set(byte%5B%5D,int,int)">ByteRange</a></code></span></div> |
| <div class="block">Reuse this <code>ByteRange</code> over a new byte[]. A null <code>bytes</code> IS supported, in which |
| case this method will behave equivalently to <a href="ByteRange.html#unset()"><code>ByteRange.unset()</code></a>, regardless of the values of |
| <code>offset</code> and <code>length</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#set(byte%5B%5D,int,int)">set</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>bytes</code> - The array to wrap.</dd> |
| <dd><code>offset</code> - The offset into <code>bytes</code> considered the beginning of this range.</dd> |
| <dd><code>length</code> - The length of this range.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setOffset(int)"> |
| <h3>setOffset</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-182">setOffset</a></span><wbr><span class="parameters">(int offset)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#setOffset(int)">ByteRange</a></code></span></div> |
| <div class="block">Update the beginning of this range. <code>offset + length</code> may not be greater than |
| <code>bytes.length</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#setOffset(int)">setOffset</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>offset</code> - the new start of this range.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLength(int)"> |
| <h3>setLength</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-185">setLength</a></span><wbr><span class="parameters">(int length)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#setLength(int)">ByteRange</a></code></span></div> |
| <div class="block">Update the length of this range. <code>offset + length</code> should not be greater than |
| <code>bytes.length</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#setLength(int)">setLength</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>length</code> - The new length of this range.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(int,byte[])"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-188">get</a></span><wbr><span class="parameters">(int index, |
| byte[] dst)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#get(int,byte%5B%5D)">ByteRange</a></code></span></div> |
| <div class="block">Fill <code>dst</code> with bytes from the range, starting from <code>index</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#get(int,byte%5B%5D)">get</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - zero-based index into this range.</dd> |
| <dd><code>dst</code> - the destination of the copy.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(int,byte[],int,int)"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-191">get</a></span><wbr><span class="parameters">(int index, |
| byte[] dst, |
| int offset, |
| int length)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#get(int,byte%5B%5D,int,int)">ByteRange</a></code></span></div> |
| <div class="block">Fill <code>dst</code> with bytes from the range, starting from <code>index</code>. <code>length</code> bytes |
| are copied into <code>dst</code>, starting at <code>offset</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#get(int,byte%5B%5D,int,int)">get</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - zero-based index into this range.</dd> |
| <dd><code>dst</code> - the destination of the copy.</dd> |
| <dd><code>offset</code> - the offset into <code>dst</code> to start the copy.</dd> |
| <dd><code>length</code> - the number of bytes to copy into <code>dst</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(int,byte)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-194">put</a></span><wbr><span class="parameters">(int index, |
| byte val)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#put(int,byte)">ByteRange</a></code></span></div> |
| <div class="block">Store <code>val</code> at <code>index</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#put(int,byte)">put</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - the index in the range where <code>val</code> is stored.</dd> |
| <dd><code>val</code> - the value to store.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putShort(int,short)"> |
| <h3>putShort</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-197">putShort</a></span><wbr><span class="parameters">(int index, |
| short val)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#putShort(int,short)">ByteRange</a></code></span></div> |
| <div class="block">Store the short value at <code>index</code></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#putShort(int,short)">putShort</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - the index in the range where <code>val</code> is stored</dd> |
| <dd><code>val</code> - the value to store</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putInt(int,int)"> |
| <h3>putInt</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-200">putInt</a></span><wbr><span class="parameters">(int index, |
| int val)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#putInt(int,int)">ByteRange</a></code></span></div> |
| <div class="block">Store the int value at <code>index</code></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#putInt(int,int)">putInt</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - the index in the range where <code>val</code> is stored</dd> |
| <dd><code>val</code> - the value to store</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="putLong(int,long)"> |
| <h3>putLong</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-203">putLong</a></span><wbr><span class="parameters">(int index, |
| long val)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#putLong(int,long)">ByteRange</a></code></span></div> |
| <div class="block">Store the long value at <code>index</code></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#putLong(int,long)">putLong</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - the index in the range where <code>val</code> is stored</dd> |
| <dd><code>val</code> - the value to store</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(int,byte[])"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-206">put</a></span><wbr><span class="parameters">(int index, |
| byte[] val)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#put(int,byte%5B%5D)">ByteRange</a></code></span></div> |
| <div class="block">Store <code>val</code> at <code>index</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#put(int,byte%5B%5D)">put</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - the index in the range where <code>val</code> is stored.</dd> |
| <dd><code>val</code> - the value to store.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(int,byte[],int,int)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-209">put</a></span><wbr><span class="parameters">(int index, |
| byte[] val, |
| int offset, |
| int length)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#put(int,byte%5B%5D,int,int)">ByteRange</a></code></span></div> |
| <div class="block">Store <code>length</code> bytes from <code>val</code> into this range, starting at <code>index</code>. Bytes |
| from <code>val</code> are copied starting at <code>offset</code> into the range.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#put(int,byte%5B%5D,int,int)">put</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - position in this range to start the copy.</dd> |
| <dd><code>val</code> - the value to store.</dd> |
| <dd><code>offset</code> - the offset in <code>val</code> from which to start copying.</dd> |
| <dd><code>length</code> - the number of bytes to copy from <code>val</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>this.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deepCopy()"> |
| <h3>deepCopy</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-212">deepCopy</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#deepCopy()">ByteRange</a></code></span></div> |
| <div class="block">Create a new <code>ByteRange</code> with new backing byte[] containing a copy of the content from |
| <code>this</code> range's window.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#deepCopy()">deepCopy</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Deep copy</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shallowCopy()"> |
| <h3>shallowCopy</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-215">shallowCopy</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#shallowCopy()">ByteRange</a></code></span></div> |
| <div class="block">Create a new <code>ByteRange</code> that points at this range's byte[]. Modifying the shallowCopy |
| will modify the bytes in this range's array. Pass over the hash code if it is already cached.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#shallowCopy()">shallowCopy</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>new <code>ByteRange</code> object referencing this range's byte[].</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shallowCopySubRange(int,int)"> |
| <h3>shallowCopySubRange</h3> |
| <div class="member-signature"><span class="return-type"><a href="PositionedByteRange.html" title="interface in org.apache.hadoop.hbase.util">PositionedByteRange</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/PositionedByteRange.html#line-218">shallowCopySubRange</a></span><wbr><span class="parameters">(int innerOffset, |
| int copyLength)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ByteRange.html#shallowCopySubRange(int,int)">ByteRange</a></code></span></div> |
| <div class="block">Create a new <code>ByteRange</code> that points at this range's byte[]. The new range can have |
| different values for offset and length, but modifying the shallowCopy will modify the bytes in |
| this range's array. Pass over the hash code if it is already cached.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ByteRange.html#shallowCopySubRange(int,int)">shallowCopySubRange</a></code> in interface <code><a href="ByteRange.html" title="interface in org.apache.hadoop.hbase.util">ByteRange</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>innerOffset</code> - First byte of clone will be this.offset + copyOffset.</dd> |
| <dd><code>copyLength</code> - Number of bytes in the clone.</dd> |
| <dt>Returns:</dt> |
| <dd>new <code>ByteRange</code> object referencing this range's byte[].</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> |