| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ByteBufferArray (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, class: ByteBufferArray"> |
| <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/ByteBufferArray.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><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.util</a></div> |
| <h1 title="Class ByteBufferArray" class="title">Class ByteBufferArray</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.util.ByteBufferArray</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/util/ByteBufferArray.html#line-40">ByteBufferArray</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">This class manages an array of ByteBuffers with a default size 4MB. These buffers are sequential |
| and could be considered as a large buffer.It supports reading/writing data from this large buffer |
| with a position and offset</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private class </code></div> |
| <div class="col-second even-row-color"><code><a href="ByteBufferArray.BufferIterator.html" class="type-name-link" title="class in org.apache.hadoop.hbase.util">ByteBufferArray.BufferIterator</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Iterator to fetch ByteBuffers from offset with given length in this big logical array.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== 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 final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#bufferCount" class="member-name-link">bufferCount</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>(package private) final <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 odd-row-color"><code><a href="#buffers" class="member-name-link">buffers</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#bufferSize" class="member-name-link">bufferSize</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_BUFFER_SIZE" class="member-name-link">DEFAULT_BUFFER_SIZE</a></code></div> |
| <div class="col-last odd-row-color"> </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 class="col-first odd-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiConsumer.html" title="class or interface in java.util.function" class="external-link">BiConsumer</a><<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>,<wbr><a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#READER" class="member-name-link">READER</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Transfer bytes from source <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> to destination <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio"><code>ByteBuff</code></a>, Position of both |
| source and destination will be advanced.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiConsumer.html" title="class or interface in java.util.function" class="external-link">BiConsumer</a><<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>,<wbr><a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#WRITER" class="member-name-link">WRITER</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Transfer bytes from source <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio"><code>ByteBuff</code></a> to destination <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>.</div> |
| </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(int,int,int,long,org.apache.hadoop.hbase.util.ByteBufferAllocator)" class="member-name-link">ByteBufferArray</a><wbr>(int bufferSize, |
| int bufferCount, |
| int threadCount, |
| long capacity, |
| <a href="ByteBufferAllocator.html" title="interface in org.apache.hadoop.hbase.util">ByteBufferAllocator</a> alloc)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(long,org.apache.hadoop.hbase.util.ByteBufferAllocator)" class="member-name-link">ByteBufferArray</a><wbr>(long capacity, |
| <a href="ByteBufferAllocator.html" title="interface in org.apache.hadoop.hbase.util">ByteBufferAllocator</a> allocator)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">We allocate a number of byte buffers as the capacity.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-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-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-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></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-tab4"><code><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-tab2 method-summary-table-tab4"><code><a href="#asSubByteBuffers(long,int)" class="member-name-link">asSubByteBuffers</a><wbr>(long offset, |
| int len)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a sub-array from a given array of ByteBuffers from the given offset to the length |
| specified.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createBuffers(int,org.apache.hadoop.hbase.util.ByteBufferAllocator)" class="member-name-link">createBuffers</a><wbr>(int threadCount, |
| <a href="ByteBufferAllocator.html" title="interface in org.apache.hadoop.hbase.util">ByteBufferAllocator</a> alloc)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private 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="#getBufferCount(long)" class="member-name-link">getBufferCount</a><wbr>(long capacity)</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 int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getBufferSize(long)" class="member-name-link">getBufferSize</a><wbr>(long capacity)</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-tab2 method-summary-table-tab4"><code>private int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#internalTransfer(long,org.apache.hadoop.hbase.nio.ByteBuff,java.util.function.BiConsumer)" class="member-name-link">internalTransfer</a><wbr>(long offset, |
| <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a> b, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiConsumer.html" title="class or interface in java.util.function" class="external-link">BiConsumer</a><<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>,<wbr><a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a>> transfer)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Transferring all remaining bytes from b to the buffers array starting at offset, or |
| transferring bytes from the buffers array at offset to b until b is filled.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#read(long,org.apache.hadoop.hbase.nio.ByteBuff)" class="member-name-link">read</a><wbr>(long offset, |
| <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a> dst)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Transfers bytes from this buffers array into the given destination <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio"><code>ByteBuff</code></a></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#roundUp(long,long)" class="member-name-link">roundUp</a><wbr>(long n, |
| long to)</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-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#write(long,org.apache.hadoop.hbase.nio.ByteBuff)" class="member-name-link">write</a><wbr>(long offset, |
| <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a> src)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Transfers bytes from the given source <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio"><code>ByteBuff</code></a> into this buffer array</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/util/ByteBufferArray.html#line-42">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_BUFFER_SIZE"> |
| <h3>DEFAULT_BUFFER_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ByteBufferArray.html#line-44">DEFAULT_BUFFER_SIZE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.ByteBufferArray.DEFAULT_BUFFER_SIZE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="bufferSize"> |
| <h3>bufferSize</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ByteBufferArray.html#line-45">bufferSize</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="bufferCount"> |
| <h3>bufferCount</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ByteBufferArray.html#line-46">bufferCount</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="buffers"> |
| <h3>buffers</h3> |
| <div class="member-signature"><span class="modifiers">final</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/util/ByteBufferArray.html#line-47">buffers</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WRITER"> |
| <h3>WRITER</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiConsumer.html" title="class or interface in java.util.function" class="external-link">BiConsumer</a><<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>,<wbr><a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ByteBufferArray.html#line-146">WRITER</a></span></div> |
| <div class="block">Transfer bytes from source <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio"><code>ByteBuff</code></a> to destination <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>. Position of both |
| source and destination will be advanced.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="READER"> |
| <h3>READER</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiConsumer.html" title="class or interface in java.util.function" class="external-link">BiConsumer</a><<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>,<wbr><a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ByteBufferArray.html#line-157">READER</a></span></div> |
| <div class="block">Transfer bytes from source <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> to destination <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio"><code>ByteBuff</code></a>, Position of both |
| source and destination will be advanced.</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>(long,org.apache.hadoop.hbase.util.ByteBufferAllocator)"> |
| <h3>ByteBufferArray</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ByteBufferArray.html#line-55">ByteBufferArray</a></span><wbr><span class="parameters">(long capacity, |
| <a href="ByteBufferAllocator.html" title="interface in org.apache.hadoop.hbase.util">ByteBufferAllocator</a> allocator)</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">We allocate a number of byte buffers as the capacity.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>capacity</code> - total size of the byte buffer array</dd> |
| <dd><code>allocator</code> - the ByteBufferAllocator that will create the buffers</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> - throws IOException if there is an exception thrown by the allocator</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(int,int,int,long,org.apache.hadoop.hbase.util.ByteBufferAllocator)"> |
| <h3>ByteBufferArray</h3> |
| <div class="member-signature"><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ByteBufferArray.html#line-60">ByteBufferArray</a></span><wbr><span class="parameters">(int bufferSize, |
| int bufferCount, |
| int threadCount, |
| long capacity, |
| <a href="ByteBufferAllocator.html" title="interface in org.apache.hadoop.hbase.util">ByteBufferAllocator</a> alloc)</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> |
| <dl class="notes"> |
| <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> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="createBuffers(int,org.apache.hadoop.hbase.util.ByteBufferAllocator)"> |
| <h3>createBuffers</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ByteBufferArray.html#line-70">createBuffers</a></span><wbr><span class="parameters">(int threadCount, |
| <a href="ByteBufferAllocator.html" title="interface in org.apache.hadoop.hbase.util">ByteBufferAllocator</a> alloc)</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> |
| <dl class="notes"> |
| <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="getBufferSize(long)"> |
| <h3>getBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ByteBufferArray.html#line-105">getBufferSize</a></span><wbr><span class="parameters">(long capacity)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBufferCount(long)"> |
| <h3>getBufferCount</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/util/ByteBufferArray.html#line-113">getBufferCount</a></span><wbr><span class="parameters">(long capacity)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="roundUp(long,long)"> |
| <h3>roundUp</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ByteBufferArray.html#line-118">roundUp</a></span><wbr><span class="parameters">(long n, |
| long to)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="read(long,org.apache.hadoop.hbase.nio.ByteBuff)"> |
| <h3>read</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ByteBufferArray.html#line-128">read</a></span><wbr><span class="parameters">(long offset, |
| <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a> dst)</span></div> |
| <div class="block">Transfers bytes from this buffers array into the given destination <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio"><code>ByteBuff</code></a></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>offset</code> - start position in this big logical array.</dd> |
| <dd><code>dst</code> - the destination ByteBuff. Notice that its position will be advanced.</dd> |
| <dt>Returns:</dt> |
| <dd>number of bytes read</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="write(long,org.apache.hadoop.hbase.nio.ByteBuff)"> |
| <h3>write</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ByteBufferArray.html#line-138">write</a></span><wbr><span class="parameters">(long offset, |
| <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a> src)</span></div> |
| <div class="block">Transfers bytes from the given source <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio"><code>ByteBuff</code></a> into this buffer array</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>offset</code> - start offset of this big logical array.</dd> |
| <dd><code>src</code> - the source ByteBuff. Notice that its position will be advanced.</dd> |
| <dt>Returns:</dt> |
| <dd>number of bytes write</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="internalTransfer(long,org.apache.hadoop.hbase.nio.ByteBuff,java.util.function.BiConsumer)"> |
| <h3>internalTransfer</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/ByteBufferArray.html#line-174">internalTransfer</a></span><wbr><span class="parameters">(long offset, |
| <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a> b, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiConsumer.html" title="class or interface in java.util.function" class="external-link">BiConsumer</a><<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>,<wbr><a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a>> transfer)</span></div> |
| <div class="block">Transferring all remaining bytes from b to the buffers array starting at offset, or |
| transferring bytes from the buffers array at offset to b until b is filled. Notice that |
| position of ByteBuff b will be advanced.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>offset</code> - where we start in the big logical array.</dd> |
| <dd><code>b</code> - the ByteBuff to transfer from or to</dd> |
| <dd><code>transfer</code> - the transfer interface.</dd> |
| <dt>Returns:</dt> |
| <dd>the length of bytes we transferred.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="asSubByteBuffers(long,int)"> |
| <h3>asSubByteBuffers</h3> |
| <div class="member-signature"><span class="modifiers">public</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/util/ByteBufferArray.html#line-201">asSubByteBuffers</a></span><wbr><span class="parameters">(long offset, |
| int len)</span></div> |
| <div class="block">Creates a sub-array from a given array of ByteBuffers from the given offset to the length |
| specified. For eg, if there are 4 buffers forming an array each with length 10 and if we call |
| asSubByteBuffers(5, 10) then we will create an sub-array consisting of two BBs and the first |
| one be a BB from 'position' 5 to a 'length' 5 and the 2nd BB will be from 'position' 0 to |
| 'length' 5.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>offset</code> - the position in the whole array which is composited by multiple byte buffers.</dd> |
| <dd><code>len</code> - the length of bytes</dd> |
| <dt>Returns:</dt> |
| <dd>the underlying ByteBuffers, each ByteBuffer is a slice from the backend and will have a |
| zero position.</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> |
