blob: 92ce46ca0be3faa6f0671b96c926fce5fde22f4d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ArrowBuf (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ArrowBuf (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":42,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ArrowBuf.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/arrow/memory/AllocatorClosedException.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/arrow/memory/ArrowBufBenchmarks.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/arrow/memory/ArrowBuf.html" target="_top">Frames</a></li>
<li><a href="ArrowBuf.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.arrow.memory</div>
<h2 title="Class ArrowBuf" class="title">Class ArrowBuf</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.arrow.memory.ArrowBuf</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">ArrowBuf</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre>
<div class="block">ArrowBuf serves as a facade over underlying memory by providing
several access APIs to read/write data into a chunk of direct
memory. All the accounting, ownership and reference management
is done by <a href="../../../../org/apache/arrow/memory/ReferenceManager.html" title="interface in org.apache.arrow.memory"><code>ReferenceManager</code></a> and ArrowBuf can work
with a custom user provided implementation of ReferenceManager
<p>
Two important instance variables of an ArrowBuf:
(1) address - starting virtual address in the underlying memory
chunk that this ArrowBuf has access to
(2) length - length (in bytes) in the underlying memory chunk
that this ArrowBuf has access to
</p>
<p>
The management (allocation, deallocation, reference counting etc) for
the memory chunk is not done by ArrowBuf.
Default implementation of ReferenceManager, allocation is in
<code>BaseAllocator</code>, <a href="../../../../org/apache/arrow/memory/BufferLedger.html" title="class in org.apache.arrow.memory"><code>BufferLedger</code></a> and <a href="../../../../org/apache/arrow/memory/AllocationManager.html" title="class in org.apache.arrow.memory"><code>AllocationManager</code></a>
</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#ArrowBuf-org.apache.arrow.memory.ReferenceManager-org.apache.arrow.memory.BufferManager-long-long-">ArrowBuf</a></span>(<a href="../../../../org/apache/arrow/memory/ReferenceManager.html" title="interface in org.apache.arrow.memory">ReferenceManager</a>&nbsp;referenceManager,
@Nullable <a href="../../../../org/apache/arrow/memory/BufferManager.html" title="interface in org.apache.arrow.memory">BufferManager</a>&nbsp;bufferManager,
long&nbsp;capacity,
long&nbsp;memoryAddress)</code>
<div class="block">Constructs a new ArrowBuf.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#capacity--">capacity</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#capacity-long-">capacity</a></span>(long&nbsp;newCapacity)</code>
<div class="block">Adjusts the capacity of this buffer.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#checkBytes-long-long-">checkBytes</a></span>(long&nbsp;start,
long&nbsp;end)</code>
<div class="block">Allows a function to determine whether not reading a particular string of bytes is valid.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#clear--">clear</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#equals-java.lang.Object-">equals</a></span>(@Nullable <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getActualMemoryConsumed--">getActualMemoryConsumed</a></span>()</code>
<div class="block">Return that is Accounted for by this buffer (and its potentially shared siblings within the
context of the associated allocator).</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getByte-long-">getByte</a></span>(long&nbsp;index)</code>
<div class="block">Get byte value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getBytes-long-org.apache.arrow.memory.ArrowBuf-long-int-">getBytes</a></span>(long&nbsp;index,
<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;dst,
long&nbsp;dstIndex,
int&nbsp;length)</code>
<div class="block">Copy a given length of data from this ArrowBuf starting at a given index
into a dst ArrowBuf at dstIndex.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getBytes-long-byte:A-">getBytes</a></span>(long&nbsp;index,
byte[]&nbsp;dst)</code>
<div class="block">Copy data from this ArrowBuf at a given index in into destination
byte array.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getBytes-long-byte:A-int-int-">getBytes</a></span>(long&nbsp;index,
byte[]&nbsp;dst,
int&nbsp;dstIndex,
int&nbsp;length)</code>
<div class="block">Copy data from this ArrowBuf at a given index into destination byte array.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getBytes-long-java.nio.ByteBuffer-">getBytes</a></span>(long&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;dst)</code>
<div class="block">Copy data from this ArrowBuf at a given index into the destination
ByteBuffer.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getBytes-long-java.io.OutputStream-int-">getBytes</a></span>(long&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>&nbsp;out,
int&nbsp;length)</code>
<div class="block">Copy a certain length of bytes from this ArrowBuf at a given
index into the given OutputStream.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>char</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getChar-long-">getChar</a></span>(long&nbsp;index)</code>
<div class="block">Get char value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getDouble-long-">getDouble</a></span>(long&nbsp;index)</code>
<div class="block">Get double value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getFloat-long-">getFloat</a></span>(long&nbsp;index)</code>
<div class="block">Get float value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getId--">getId</a></span>()</code>
<div class="block">Get the integer id assigned to this ArrowBuf for debugging purposes.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getInt-long-">getInt</a></span>(long&nbsp;index)</code>
<div class="block">Get int value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getLong-long-">getLong</a></span>(long&nbsp;index)</code>
<div class="block">Get long value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getPossibleMemoryConsumed--">getPossibleMemoryConsumed</a></span>()</code>
<div class="block">Returns the possible memory consumed by this ArrowBuf in the worse case scenario.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ReferenceManager.html" title="interface in org.apache.arrow.memory">ReferenceManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getReferenceManager--">getReferenceManager</a></span>()</code>
<div class="block">Get reference manager for this ArrowBuf.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#getShort-long-">getShort</a></span>(long&nbsp;index)</code>
<div class="block">Get short value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#memoryAddress--">memoryAddress</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#nioBuffer--">nioBuffer</a></span>()</code>
<div class="block">Make a nio byte buffer from this arrowbuf.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#nioBuffer-long-int-">nioBuffer</a></span>(long&nbsp;index,
int&nbsp;length)</code>
<div class="block">Make a nio byte buffer from this ArrowBuf.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteOrder.html?is-external=true" title="class or interface in java.nio">ByteOrder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#order--">order</a></span>()</code>
<div class="block">Returns the byte order of elements in this buffer.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#print-java.lang.StringBuilder-int-">print</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;sb,
int&nbsp;indent)</code>
<div class="block">Print detailed information of this buffer into <code>sb</code>.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#print-java.lang.StringBuilder-int-org.apache.arrow.memory.BaseAllocator.Verbosity-">print</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;sb,
int&nbsp;indent,
org.apache.arrow.memory.BaseAllocator.Verbosity&nbsp;verbosity)</code>
<div class="block">Print information of this buffer into <code>sb</code> at the given
indentation and verbosity level.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#readableBytes--">readableBytes</a></span>()</code>
<div class="block">Returns the number of bytes still available to read in this buffer.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#readByte--">readByte</a></span>()</code>
<div class="block">Read the byte at readerIndex.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#readBytes-byte:A-">readBytes</a></span>(byte[]&nbsp;dst)</code>
<div class="block">Read dst.length bytes at readerIndex into dst byte array</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#readerIndex--">readerIndex</a></span>()</code>
<div class="block">Get the index at which the next byte will be read from.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#readerIndex-long-">readerIndex</a></span>(long&nbsp;readerIndex)</code>
<div class="block">Set the reader index for this ArrowBuf.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#reallocIfNeeded-long-">reallocIfNeeded</a></span>(long&nbsp;size)</code>
<div class="block">Returns <code>this</code> if size is less than <a href="../../../../org/apache/arrow/memory/ArrowBuf.html#capacity--"><code>capacity()</code></a>, otherwise
delegates to <a href="../../../../org/apache/arrow/memory/BufferManager.html#replace-org.apache.arrow.memory.ArrowBuf-long-"><code>BufferManager.replace(ArrowBuf, long)</code></a> to get a new buffer.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#refCnt--">refCnt</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setByte-long-byte-">setByte</a></span>(long&nbsp;index,
byte&nbsp;value)</code>
<div class="block">Set byte value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setByte-long-int-">setByte</a></span>(long&nbsp;index,
int&nbsp;value)</code>
<div class="block">Set byte value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setBytes-long-org.apache.arrow.memory.ArrowBuf-">setBytes</a></span>(long&nbsp;index,
<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;src)</code>
<div class="block">Copy readableBytes() number of bytes from src ArrowBuf
starting from its readerIndex into this ArrowBuf starting
at the given index.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setBytes-long-org.apache.arrow.memory.ArrowBuf-long-long-">setBytes</a></span>(long&nbsp;index,
<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;src,
long&nbsp;srcIndex,
long&nbsp;length)</code>
<div class="block">Copy data from src ArrowBuf starting at index srcIndex into this
ArrowBuf at given index.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setBytes-long-byte:A-">setBytes</a></span>(long&nbsp;index,
byte[]&nbsp;src)</code>
<div class="block">Copy data from a given byte array into this ArrowBuf starting at
a given index.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setBytes-long-byte:A-int-long-">setBytes</a></span>(long&nbsp;index,
byte[]&nbsp;src,
int&nbsp;srcIndex,
long&nbsp;length)</code>
<div class="block">Copy data from a given byte array starting at the given source index into
this ArrowBuf at a given index.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setBytes-long-java.nio.ByteBuffer-">setBytes</a></span>(long&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;src)</code>
<div class="block">Copy data into this ArrowBuf at a given index onwards from
a source ByteBuffer.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setBytes-long-java.nio.ByteBuffer-int-int-">setBytes</a></span>(long&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;src,
int&nbsp;srcIndex,
int&nbsp;length)</code>
<div class="block">Copy data into this ArrowBuf at a given index onwards from
a source ByteBuffer starting at a given srcIndex for a certain
length.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setBytes-long-java.io.InputStream-int-">setBytes</a></span>(long&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;in,
int&nbsp;length)</code>
<div class="block">Copy a certain length of bytes from given InputStream
into this ArrowBuf at the provided index.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setChar-long-int-">setChar</a></span>(long&nbsp;index,
int&nbsp;value)</code>
<div class="block">Set char value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setDouble-long-double-">setDouble</a></span>(long&nbsp;index,
double&nbsp;value)</code>
<div class="block">Set double value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setFloat-long-float-">setFloat</a></span>(long&nbsp;index,
float&nbsp;value)</code>
<div class="block">Set float value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setInt-long-int-">setInt</a></span>(long&nbsp;index,
int&nbsp;value)</code>
<div class="block">Set int value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setLong-long-long-">setLong</a></span>(long&nbsp;index,
long&nbsp;value)</code>
<div class="block">Set long value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setOne-int-int-">setOne</a></span>(int&nbsp;index,
int&nbsp;length)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setOne-long-long-"><code>setOne(long, long)</code></a> instead.</span></div>
</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setOne-long-long-">setOne</a></span>(long&nbsp;index,
long&nbsp;length)</code>
<div class="block">Sets all bits to one in the specified range.</div>
</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setShort-long-int-">setShort</a></span>(long&nbsp;index,
int&nbsp;value)</code>
<div class="block">Set short value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setShort-long-short-">setShort</a></span>(long&nbsp;index,
short&nbsp;value)</code>
<div class="block">Set short value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setZero-long-long-">setZero</a></span>(long&nbsp;index,
long&nbsp;length)</code>
<div class="block">Zero-out the bytes in this ArrowBuf starting at
the given index for the given length.</div>
</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#slice--">slice</a></span>()</code>
<div class="block">Returns a slice of only the readable bytes in the buffer.</div>
</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#slice-long-long-">slice</a></span>(long&nbsp;index,
long&nbsp;length)</code>
<div class="block">Returns a slice (view) starting at <code>index</code> with the given <code>length</code>.</div>
</td>
</tr>
<tr id="i57" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#toHexString-long-int-">toHexString</a></span>(long&nbsp;start,
int&nbsp;length)</code>
<div class="block">Return the buffer's byte contents in the form of a hex dump.</div>
</td>
</tr>
<tr id="i58" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i59" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#writableBytes--">writableBytes</a></span>()</code>
<div class="block">Returns the number of bytes still available to write into this buffer before capacity is reached.</div>
</td>
</tr>
<tr id="i60" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#writeByte-byte-">writeByte</a></span>(byte&nbsp;value)</code>
<div class="block">Set the provided byte value at the writerIndex.</div>
</td>
</tr>
<tr id="i61" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#writeByte-int-">writeByte</a></span>(int&nbsp;value)</code>
<div class="block">Set the lower order byte for the provided value at
the writerIndex.</div>
</td>
</tr>
<tr id="i62" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#writeBytes-byte:A-">writeBytes</a></span>(byte[]&nbsp;src)</code>
<div class="block">Write the bytes from given byte array into this
ArrowBuf starting at writerIndex.</div>
</td>
</tr>
<tr id="i63" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#writeBytes-byte:A-int-int-">writeBytes</a></span>(byte[]&nbsp;src,
int&nbsp;srcIndex,
int&nbsp;length)</code>
<div class="block">Write the bytes from given byte array starting at srcIndex
into this ArrowBuf starting at writerIndex.</div>
</td>
</tr>
<tr id="i64" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#writeDouble-double-">writeDouble</a></span>(double&nbsp;value)</code>
<div class="block">Set the provided double value at the writerIndex.</div>
</td>
</tr>
<tr id="i65" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#writeFloat-float-">writeFloat</a></span>(float&nbsp;value)</code>
<div class="block">Set the provided float value at the writerIndex.</div>
</td>
</tr>
<tr id="i66" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#writeInt-int-">writeInt</a></span>(int&nbsp;value)</code>
<div class="block">Set the provided int value at the writerIndex.</div>
</td>
</tr>
<tr id="i67" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#writeLong-long-">writeLong</a></span>(long&nbsp;value)</code>
<div class="block">Set the provided long value at the writerIndex.</div>
</td>
</tr>
<tr id="i68" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#writerIndex--">writerIndex</a></span>()</code>
<div class="block">Get the index at which next byte will be written to.</div>
</td>
</tr>
<tr id="i69" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#writerIndex-long-">writerIndex</a></span>(long&nbsp;writerIndex)</code>
<div class="block">Set the writer index for this ArrowBuf.</div>
</td>
</tr>
<tr id="i70" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/ArrowBuf.html#writeShort-int-">writeShort</a></span>(int&nbsp;value)</code>
<div class="block">Set the provided int value as short at the writerIndex.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ArrowBuf-org.apache.arrow.memory.ReferenceManager-org.apache.arrow.memory.BufferManager-long-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ArrowBuf</h4>
<pre>public&nbsp;ArrowBuf(<a href="../../../../org/apache/arrow/memory/ReferenceManager.html" title="interface in org.apache.arrow.memory">ReferenceManager</a>&nbsp;referenceManager,
@Nullable <a href="../../../../org/apache/arrow/memory/BufferManager.html" title="interface in org.apache.arrow.memory">BufferManager</a>&nbsp;bufferManager,
long&nbsp;capacity,
long&nbsp;memoryAddress)</pre>
<div class="block">Constructs a new ArrowBuf.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>referenceManager</code> - The memory manager to track memory usage and reference count of this buffer</dd>
<dd><code>capacity</code> - The capacity in bytes of this buffer</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="refCnt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refCnt</h4>
<pre>public&nbsp;int&nbsp;refCnt()</pre>
</li>
</ul>
<a name="checkBytes-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkBytes</h4>
<pre>public&nbsp;void&nbsp;checkBytes(long&nbsp;start,
long&nbsp;end)</pre>
<div class="block">Allows a function to determine whether not reading a particular string of bytes is valid.
<p>Will throw an exception if the memory is not readable for some reason. Only doesn't
something in the case that
AssertionUtil.BOUNDS_CHECKING_ENABLED is true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>start</code> - The starting position of the bytes to be read.</dd>
<dd><code>end</code> - The exclusive endpoint of the bytes to be read.</dd>
</dl>
</li>
</ul>
<a name="getReferenceManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReferenceManager</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/memory/ReferenceManager.html" title="interface in org.apache.arrow.memory">ReferenceManager</a>&nbsp;getReferenceManager()</pre>
<div class="block">Get reference manager for this ArrowBuf.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>user provided implementation of <a href="../../../../org/apache/arrow/memory/ReferenceManager.html" title="interface in org.apache.arrow.memory"><code>ReferenceManager</code></a></dd>
</dl>
</li>
</ul>
<a name="capacity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>capacity</h4>
<pre>public&nbsp;long&nbsp;capacity()</pre>
</li>
</ul>
<a name="capacity-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>capacity</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;capacity(long&nbsp;newCapacity)</pre>
<div class="block">Adjusts the capacity of this buffer. Size increases are NOT supported.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newCapacity</code> - Must be in in the range [0, length).</dd>
</dl>
</li>
</ul>
<a name="order--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>order</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteOrder.html?is-external=true" title="class or interface in java.nio">ByteOrder</a>&nbsp;order()</pre>
<div class="block">Returns the byte order of elements in this buffer.</div>
</li>
</ul>
<a name="readableBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readableBytes</h4>
<pre>public&nbsp;long&nbsp;readableBytes()</pre>
<div class="block">Returns the number of bytes still available to read in this buffer.</div>
</li>
</ul>
<a name="writableBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writableBytes</h4>
<pre>public&nbsp;long&nbsp;writableBytes()</pre>
<div class="block">Returns the number of bytes still available to write into this buffer before capacity is reached.</div>
</li>
</ul>
<a name="slice--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>slice</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;slice()</pre>
<div class="block">Returns a slice of only the readable bytes in the buffer.</div>
</li>
</ul>
<a name="slice-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>slice</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;slice(long&nbsp;index,
long&nbsp;length)</pre>
<div class="block">Returns a slice (view) starting at <code>index</code> with the given <code>length</code>.</div>
</li>
</ul>
<a name="nioBuffer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nioBuffer</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;nioBuffer()</pre>
<div class="block">Make a nio byte buffer from this arrowbuf.</div>
</li>
</ul>
<a name="nioBuffer-long-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nioBuffer</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;nioBuffer(long&nbsp;index,
int&nbsp;length)</pre>
<div class="block">Make a nio byte buffer from this ArrowBuf.</div>
</li>
</ul>
<a name="memoryAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>memoryAddress</h4>
<pre>public&nbsp;long&nbsp;memoryAddress()</pre>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(@Nullable <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="getLong-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLong</h4>
<pre>public&nbsp;long&nbsp;getLong(long&nbsp;index)</pre>
<div class="block">Get long value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be read from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>8 byte long value</dd>
</dl>
</li>
</ul>
<a name="setLong-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLong</h4>
<pre>public&nbsp;void&nbsp;setLong(long&nbsp;index,
long&nbsp;value)</pre>
<div class="block">Set long value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be written</dd>
<dd><code>value</code> - value to write</dd>
</dl>
</li>
</ul>
<a name="getFloat-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFloat</h4>
<pre>public&nbsp;float&nbsp;getFloat(long&nbsp;index)</pre>
<div class="block">Get float value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be read from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>4 byte float value</dd>
</dl>
</li>
</ul>
<a name="setFloat-long-float-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFloat</h4>
<pre>public&nbsp;void&nbsp;setFloat(long&nbsp;index,
float&nbsp;value)</pre>
<div class="block">Set float value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be written</dd>
<dd><code>value</code> - value to write</dd>
</dl>
</li>
</ul>
<a name="getDouble-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDouble</h4>
<pre>public&nbsp;double&nbsp;getDouble(long&nbsp;index)</pre>
<div class="block">Get double value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be read from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>8 byte double value</dd>
</dl>
</li>
</ul>
<a name="setDouble-long-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDouble</h4>
<pre>public&nbsp;void&nbsp;setDouble(long&nbsp;index,
double&nbsp;value)</pre>
<div class="block">Set double value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be written</dd>
<dd><code>value</code> - value to write</dd>
</dl>
</li>
</ul>
<a name="getChar-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChar</h4>
<pre>public&nbsp;char&nbsp;getChar(long&nbsp;index)</pre>
<div class="block">Get char value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be read from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>2 byte char value</dd>
</dl>
</li>
</ul>
<a name="setChar-long-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setChar</h4>
<pre>public&nbsp;void&nbsp;setChar(long&nbsp;index,
int&nbsp;value)</pre>
<div class="block">Set char value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be written</dd>
<dd><code>value</code> - value to write</dd>
</dl>
</li>
</ul>
<a name="getInt-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInt</h4>
<pre>public&nbsp;int&nbsp;getInt(long&nbsp;index)</pre>
<div class="block">Get int value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be read from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>4 byte int value</dd>
</dl>
</li>
</ul>
<a name="setInt-long-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInt</h4>
<pre>public&nbsp;void&nbsp;setInt(long&nbsp;index,
int&nbsp;value)</pre>
<div class="block">Set int value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be written</dd>
<dd><code>value</code> - value to write</dd>
</dl>
</li>
</ul>
<a name="getShort-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShort</h4>
<pre>public&nbsp;short&nbsp;getShort(long&nbsp;index)</pre>
<div class="block">Get short value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be read from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>2 byte short value</dd>
</dl>
</li>
</ul>
<a name="setShort-long-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShort</h4>
<pre>public&nbsp;void&nbsp;setShort(long&nbsp;index,
int&nbsp;value)</pre>
<div class="block">Set short value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be written</dd>
<dd><code>value</code> - value to write</dd>
</dl>
</li>
</ul>
<a name="setShort-long-short-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShort</h4>
<pre>public&nbsp;void&nbsp;setShort(long&nbsp;index,
short&nbsp;value)</pre>
<div class="block">Set short value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be written</dd>
<dd><code>value</code> - value to write</dd>
</dl>
</li>
</ul>
<a name="setByte-long-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setByte</h4>
<pre>public&nbsp;void&nbsp;setByte(long&nbsp;index,
int&nbsp;value)</pre>
<div class="block">Set byte value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be written</dd>
<dd><code>value</code> - value to write</dd>
</dl>
</li>
</ul>
<a name="setByte-long-byte-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setByte</h4>
<pre>public&nbsp;void&nbsp;setByte(long&nbsp;index,
byte&nbsp;value)</pre>
<div class="block">Set byte value at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be written</dd>
<dd><code>value</code> - value to write</dd>
</dl>
</li>
</ul>
<a name="getByte-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByte</h4>
<pre>public&nbsp;byte&nbsp;getByte(long&nbsp;index)</pre>
<div class="block">Get byte value stored at a particular index in the
underlying memory chunk this ArrowBuf has access to.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to this ArrowBuf)
where the value will be read from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>byte value</dd>
</dl>
</li>
</ul>
<a name="readByte--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readByte</h4>
<pre>public&nbsp;byte&nbsp;readByte()</pre>
<div class="block">Read the byte at readerIndex.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>byte value</dd>
</dl>
</li>
</ul>
<a name="readBytes-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readBytes</h4>
<pre>public&nbsp;void&nbsp;readBytes(byte[]&nbsp;dst)</pre>
<div class="block">Read dst.length bytes at readerIndex into dst byte array</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dst</code> - byte array where the data will be written</dd>
</dl>
</li>
</ul>
<a name="writeByte-byte-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeByte</h4>
<pre>public&nbsp;void&nbsp;writeByte(byte&nbsp;value)</pre>
<div class="block">Set the provided byte value at the writerIndex.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - value to set</dd>
</dl>
</li>
</ul>
<a name="writeByte-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeByte</h4>
<pre>public&nbsp;void&nbsp;writeByte(int&nbsp;value)</pre>
<div class="block">Set the lower order byte for the provided value at
the writerIndex.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - value to be set</dd>
</dl>
</li>
</ul>
<a name="writeBytes-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeBytes</h4>
<pre>public&nbsp;void&nbsp;writeBytes(byte[]&nbsp;src)</pre>
<div class="block">Write the bytes from given byte array into this
ArrowBuf starting at writerIndex.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>src</code> - src byte array</dd>
</dl>
</li>
</ul>
<a name="writeBytes-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeBytes</h4>
<pre>public&nbsp;void&nbsp;writeBytes(byte[]&nbsp;src,
int&nbsp;srcIndex,
int&nbsp;length)</pre>
<div class="block">Write the bytes from given byte array starting at srcIndex
into this ArrowBuf starting at writerIndex.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>src</code> - src byte array</dd>
<dd><code>srcIndex</code> - index in the byte array where the copy will being from</dd>
<dd><code>length</code> - length of data to copy</dd>
</dl>
</li>
</ul>
<a name="writeShort-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeShort</h4>
<pre>public&nbsp;void&nbsp;writeShort(int&nbsp;value)</pre>
<div class="block">Set the provided int value as short at the writerIndex.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - value to set</dd>
</dl>
</li>
</ul>
<a name="writeInt-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeInt</h4>
<pre>public&nbsp;void&nbsp;writeInt(int&nbsp;value)</pre>
<div class="block">Set the provided int value at the writerIndex.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - value to set</dd>
</dl>
</li>
</ul>
<a name="writeLong-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeLong</h4>
<pre>public&nbsp;void&nbsp;writeLong(long&nbsp;value)</pre>
<div class="block">Set the provided long value at the writerIndex.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - value to set</dd>
</dl>
</li>
</ul>
<a name="writeFloat-float-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeFloat</h4>
<pre>public&nbsp;void&nbsp;writeFloat(float&nbsp;value)</pre>
<div class="block">Set the provided float value at the writerIndex.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - value to set</dd>
</dl>
</li>
</ul>
<a name="writeDouble-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeDouble</h4>
<pre>public&nbsp;void&nbsp;writeDouble(double&nbsp;value)</pre>
<div class="block">Set the provided double value at the writerIndex.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - value to set</dd>
</dl>
</li>
</ul>
<a name="getBytes-long-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre>public&nbsp;void&nbsp;getBytes(long&nbsp;index,
byte[]&nbsp;dst)</pre>
<div class="block">Copy data from this ArrowBuf at a given index in into destination
byte array.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - starting index (0 based relative to the portion of memory)
this ArrowBuf has access to</dd>
<dd><code>dst</code> - byte array to copy the data into</dd>
</dl>
</li>
</ul>
<a name="getBytes-long-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre>public&nbsp;void&nbsp;getBytes(long&nbsp;index,
byte[]&nbsp;dst,
int&nbsp;dstIndex,
int&nbsp;length)</pre>
<div class="block">Copy data from this ArrowBuf at a given index into destination byte array.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to the portion of memory
this ArrowBuf has access to)</dd>
<dd><code>dst</code> - byte array to copy the data into</dd>
<dd><code>dstIndex</code> - starting index in dst byte array to copy into</dd>
<dd><code>length</code> - length of data to copy from this ArrowBuf</dd>
</dl>
</li>
</ul>
<a name="setBytes-long-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBytes</h4>
<pre>public&nbsp;void&nbsp;setBytes(long&nbsp;index,
byte[]&nbsp;src)</pre>
<div class="block">Copy data from a given byte array into this ArrowBuf starting at
a given index.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - starting index (0 based relative to the portion of memory)
this ArrowBuf has access to</dd>
<dd><code>src</code> - byte array to copy the data from</dd>
</dl>
</li>
</ul>
<a name="setBytes-long-byte:A-int-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBytes</h4>
<pre>public&nbsp;void&nbsp;setBytes(long&nbsp;index,
byte[]&nbsp;src,
int&nbsp;srcIndex,
long&nbsp;length)</pre>
<div class="block">Copy data from a given byte array starting at the given source index into
this ArrowBuf at a given index.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to the portion of memory this ArrowBuf
has access to)</dd>
<dd><code>src</code> - src byte array to copy the data from</dd>
<dd><code>srcIndex</code> - index in the byte array where the copy will start from</dd>
<dd><code>length</code> - length of data to copy from byte array</dd>
</dl>
</li>
</ul>
<a name="getBytes-long-java.nio.ByteBuffer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre>public&nbsp;void&nbsp;getBytes(long&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;dst)</pre>
<div class="block">Copy data from this ArrowBuf at a given index into the destination
ByteBuffer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to the portion of memory this ArrowBuf
has access to)</dd>
<dd><code>dst</code> - dst ByteBuffer where the data will be copied into</dd>
</dl>
</li>
</ul>
<a name="setBytes-long-java.nio.ByteBuffer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBytes</h4>
<pre>public&nbsp;void&nbsp;setBytes(long&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;src)</pre>
<div class="block">Copy data into this ArrowBuf at a given index onwards from
a source ByteBuffer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index index (0 based relative to the portion of memory
this ArrowBuf has access to)</dd>
<dd><code>src</code> - src ByteBuffer where the data will be copied from</dd>
</dl>
</li>
</ul>
<a name="setBytes-long-java.nio.ByteBuffer-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBytes</h4>
<pre>public&nbsp;void&nbsp;setBytes(long&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;src,
int&nbsp;srcIndex,
int&nbsp;length)</pre>
<div class="block">Copy data into this ArrowBuf at a given index onwards from
a source ByteBuffer starting at a given srcIndex for a certain
length.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to the portion of memory
this ArrowBuf has access to)</dd>
<dd><code>src</code> - src ByteBuffer where the data will be copied from</dd>
<dd><code>srcIndex</code> - starting index in the src ByteBuffer where the data copy
will start from</dd>
<dd><code>length</code> - length of data to copy from src ByteBuffer</dd>
</dl>
</li>
</ul>
<a name="getBytes-long-org.apache.arrow.memory.ArrowBuf-long-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre>public&nbsp;void&nbsp;getBytes(long&nbsp;index,
<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;dst,
long&nbsp;dstIndex,
int&nbsp;length)</pre>
<div class="block">Copy a given length of data from this ArrowBuf starting at a given index
into a dst ArrowBuf at dstIndex.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index (0 based relative to the portion of memory
this ArrowBuf has access to)</dd>
<dd><code>dst</code> - dst ArrowBuf where the data will be copied into</dd>
<dd><code>dstIndex</code> - index (0 based relative to the portion of memory
dst ArrowBuf has access to)</dd>
<dd><code>length</code> - length of data to copy</dd>
</dl>
</li>
</ul>
<a name="setBytes-long-org.apache.arrow.memory.ArrowBuf-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBytes</h4>
<pre>public&nbsp;void&nbsp;setBytes(long&nbsp;index,
<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;src,
long&nbsp;srcIndex,
long&nbsp;length)</pre>
<div class="block">Copy data from src ArrowBuf starting at index srcIndex into this
ArrowBuf at given index.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index index (0 based relative to the portion of memory
this ArrowBuf has access to)</dd>
<dd><code>src</code> - src ArrowBuf where the data will be copied from</dd>
<dd><code>srcIndex</code> - starting index in the src ArrowBuf where the copy
will begin from</dd>
<dd><code>length</code> - length of data to copy from src ArrowBuf</dd>
</dl>
</li>
</ul>
<a name="setBytes-long-org.apache.arrow.memory.ArrowBuf-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBytes</h4>
<pre>public&nbsp;void&nbsp;setBytes(long&nbsp;index,
<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;src)</pre>
<div class="block">Copy readableBytes() number of bytes from src ArrowBuf
starting from its readerIndex into this ArrowBuf starting
at the given index.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index index (0 based relative to the portion of memory
this ArrowBuf has access to)</dd>
<dd><code>src</code> - src ArrowBuf where the data will be copied from</dd>
</dl>
</li>
</ul>
<a name="setBytes-long-java.io.InputStream-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBytes</h4>
<pre>public&nbsp;int&nbsp;setBytes(long&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;in,
int&nbsp;length)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Copy a certain length of bytes from given InputStream
into this ArrowBuf at the provided index.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index index (0 based relative to the portion of memory
this ArrowBuf has access to)</dd>
<dd><code>in</code> - src stream to copy from</dd>
<dd><code>length</code> - length of data to copy</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of bytes copied from stream into ArrowBuf</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on failing to read from stream</dd>
</dl>
</li>
</ul>
<a name="getBytes-long-java.io.OutputStream-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre>public&nbsp;void&nbsp;getBytes(long&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>&nbsp;out,
int&nbsp;length)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Copy a certain length of bytes from this ArrowBuf at a given
index into the given OutputStream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index index (0 based relative to the portion of memory
this ArrowBuf has access to)</dd>
<dd><code>out</code> - dst stream to copy data into</dd>
<dd><code>length</code> - length of data to copy</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on failing to write to stream</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
</dl>
</li>
</ul>
<a name="getPossibleMemoryConsumed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPossibleMemoryConsumed</h4>
<pre>public&nbsp;long&nbsp;getPossibleMemoryConsumed()</pre>
<div class="block">Returns the possible memory consumed by this ArrowBuf in the worse case scenario.
(not shared, connected to larger underlying buffer of allocated memory)</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Size in bytes.</dd>
</dl>
</li>
</ul>
<a name="getActualMemoryConsumed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActualMemoryConsumed</h4>
<pre>public&nbsp;long&nbsp;getActualMemoryConsumed()</pre>
<div class="block">Return that is Accounted for by this buffer (and its potentially shared siblings within the
context of the associated allocator).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Size in bytes.</dd>
</dl>
</li>
</ul>
<a name="toHexString-long-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toHexString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toHexString(long&nbsp;start,
int&nbsp;length)</pre>
<div class="block">Return the buffer's byte contents in the form of a hex dump.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>start</code> - the starting byte index</dd>
<dd><code>length</code> - how many bytes to log</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A hex dump in a String.</dd>
</dl>
</li>
</ul>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>public&nbsp;long&nbsp;getId()</pre>
<div class="block">Get the integer id assigned to this ArrowBuf for debugging purposes.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>integer id</dd>
</dl>
</li>
</ul>
<a name="print-java.lang.StringBuilder-int-org.apache.arrow.memory.BaseAllocator.Verbosity-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre>public&nbsp;void&nbsp;print(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;sb,
int&nbsp;indent,
org.apache.arrow.memory.BaseAllocator.Verbosity&nbsp;verbosity)</pre>
<div class="block">Print information of this buffer into <code>sb</code> at the given
indentation and verbosity level.
<p>It will include history if BaseAllocator.DEBUG is true and
the verbosity.includeHistoricalLog are true.</div>
</li>
</ul>
<a name="print-java.lang.StringBuilder-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>print</h4>
<pre>public&nbsp;void&nbsp;print(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;sb,
int&nbsp;indent)</pre>
<div class="block">Print detailed information of this buffer into <code>sb</code>.
<p>Most information will only be present if BaseAllocator.DEBUG is true.</div>
</li>
</ul>
<a name="readerIndex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readerIndex</h4>
<pre>public&nbsp;long&nbsp;readerIndex()</pre>
<div class="block">Get the index at which the next byte will be read from.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>reader index</dd>
</dl>
</li>
</ul>
<a name="writerIndex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writerIndex</h4>
<pre>public&nbsp;long&nbsp;writerIndex()</pre>
<div class="block">Get the index at which next byte will be written to.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>writer index</dd>
</dl>
</li>
</ul>
<a name="readerIndex-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readerIndex</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;readerIndex(long&nbsp;readerIndex)</pre>
<div class="block">Set the reader index for this ArrowBuf.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>readerIndex</code> - new reader index</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this ArrowBuf</dd>
</dl>
</li>
</ul>
<a name="writerIndex-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writerIndex</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;writerIndex(long&nbsp;writerIndex)</pre>
<div class="block">Set the writer index for this ArrowBuf.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>writerIndex</code> - new writer index</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this ArrowBuf</dd>
</dl>
</li>
</ul>
<a name="setZero-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setZero</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;setZero(long&nbsp;index,
long&nbsp;length)</pre>
<div class="block">Zero-out the bytes in this ArrowBuf starting at
the given index for the given length.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index index (0 based relative to the portion of memory
this ArrowBuf has access to)</dd>
<dd><code>length</code> - length of bytes to zero-out</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this ArrowBuf</dd>
</dl>
</li>
</ul>
<a name="setOne-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOne</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;setOne(int&nbsp;index,
int&nbsp;length)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../../../../org/apache/arrow/memory/ArrowBuf.html#setOne-long-long-"><code>setOne(long, long)</code></a> instead.</span></div>
<div class="block">Sets all bits to one in the specified range.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index index (0 based relative to the portion of memory
this ArrowBuf has access to)</dd>
<dd><code>length</code> - length of bytes to set.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this ArrowBuf</dd>
</dl>
</li>
</ul>
<a name="setOne-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOne</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;setOne(long&nbsp;index,
long&nbsp;length)</pre>
<div class="block">Sets all bits to one in the specified range.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - index index (0 based relative to the portion of memory
this ArrowBuf has access to)</dd>
<dd><code>length</code> - length of bytes to set.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this ArrowBuf</dd>
</dl>
</li>
</ul>
<a name="reallocIfNeeded-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reallocIfNeeded</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;reallocIfNeeded(long&nbsp;size)</pre>
<div class="block">Returns <code>this</code> if size is less than <a href="../../../../org/apache/arrow/memory/ArrowBuf.html#capacity--"><code>capacity()</code></a>, otherwise
delegates to <a href="../../../../org/apache/arrow/memory/BufferManager.html#replace-org.apache.arrow.memory.ArrowBuf-long-"><code>BufferManager.replace(ArrowBuf, long)</code></a> to get a new buffer.</div>
</li>
</ul>
<a name="clear--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clear</h4>
<pre>public&nbsp;<a href="../../../../org/apache/arrow/memory/ArrowBuf.html" title="class in org.apache.arrow.memory">ArrowBuf</a>&nbsp;clear()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ArrowBuf.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/arrow/memory/AllocatorClosedException.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/arrow/memory/ArrowBufBenchmarks.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/arrow/memory/ArrowBuf.html" target="_top">Frames</a></li>
<li><a href="ArrowBuf.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>