http://git-wip-us.apache.org/repos/asf/arrow-site/blob/355ede33/docs/java/org/apache/arrow/memory/BaseAllocator.html ---------------------------------------------------------------------- diff --git a/docs/java/org/apache/arrow/memory/BaseAllocator.html b/docs/java/org/apache/arrow/memory/BaseAllocator.html new file mode 100644 index 0000000..fc8bceb --- /dev/null +++ b/docs/java/org/apache/arrow/memory/BaseAllocator.html @@ -0,0 +1,869 @@ +<!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 (1.8.0_121) on Sun Apr 23 17:49:08 EDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>BaseAllocator (Apache Arrow Java Root POM 0.2.1-SNAPSHOT API)</title> +<meta name="date" content="2017-04-23"> +<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="BaseAllocator (Apache Arrow Java Root POM 0.2.1-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":9,"i12":9,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/BaseAllocator.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/ArrowByteBufAllocator.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/BaseAllocator.Reservation.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/arrow/memory/BaseAllocator.html" target="_top">Frames</a></li> +<li><a href="BaseAllocator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><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="subNavList"> +<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> +<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 BaseAllocator" class="title">Class BaseAllocator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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.BaseAllocator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/arrow/memory/RootAllocator.html" title="class in org.apache.arrow.memory">RootAllocator</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">BaseAllocator</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/Accountant.AllocationOutcome.html" title="enum in org.apache.arrow.memory">Accountant.AllocationOutcome</a></span></code> +<div class="block">Describes the type of outcome that occurred when trying to account for allocation of memory.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.Reservation.html" title="class in org.apache.arrow.memory">BaseAllocator.Reservation</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.Verbosity.html" title="enum in org.apache.arrow.memory">BaseAllocator.Verbosity</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#DEBUG">DEBUG</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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/BaseAllocator.html#DEBUG_ALLOCATOR">DEBUG_ALLOCATOR</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#DEBUG_LOG_LENGTH">DEBUG_LOG_LENGTH</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected org.apache.arrow.memory.Accountant</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#parent">parent</a></span></code> +<div class="block">The parent allocator</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#reservation">reservation</a></span></code> +<div class="block">The amount of memory reserved for this allocator.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#BaseAllocator-org.apache.arrow.memory.AllocationListener-java.lang.String-long-long-">BaseAllocator</a></span>(<a href="../../../../org/apache/arrow/memory/AllocationListener.html" title="interface in org.apache.arrow.memory">AllocationListener</a> listener, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + long initReservation, + long maxAllocation)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#BaseAllocator-org.apache.arrow.memory.BaseAllocator-java.lang.String-long-long-">BaseAllocator</a></span>(<a href="../../../../org/apache/arrow/memory/BaseAllocator.html" title="class in org.apache.arrow.memory">BaseAllocator</a> parentAllocator, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + long initReservation, + long maxAllocation)</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#assertOpen--">assertOpen</a></span>()</code> +<div class="block">Asserts (using java assertions) that the provided allocator is currently open.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#buffer-int-">buffer</a></span>(int initialRequestSize)</code> +<div class="block">Allocate a new or reused buffer of the provided size.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#buffer-int-org.apache.arrow.memory.BufferManager-">buffer</a></span>(int initialRequestSize, + <a href="../../../../org/apache/arrow/memory/BufferManager.html" title="interface in org.apache.arrow.memory">BufferManager</a> manager)</code> +<div class="block">Allocate a new or reused buffer of the provided size.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#close--">close</a></span>()</code> +<div class="block">Close this Accountant.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#getAllocatedMemory--">getAllocatedMemory</a></span>()</code> +<div class="block">Return the current amount of allocated memory that this Accountant is managing accounting + for.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/ArrowByteBufAllocator.html" title="class in org.apache.arrow.memory">ArrowByteBufAllocator</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#getAsByteBufAllocator--">getAsByteBufAllocator</a></span>()</code> +<div class="block">Returns the allocator this allocator falls back to when it needs more memory.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#getEmpty--">getEmpty</a></span>()</code> +<div class="block">Get a reference to the empty buffer associated with this allocator.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#getHeadroom--">getHeadroom</a></span>()</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#getLimit--">getLimit</a></span>()</code> +<div class="block">Return the current limit of this Accountant.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/BaseAllocator.html#getName--">getName</a></span>()</code> +<div class="block">Return the name of this allocator.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#getPeakMemoryAllocation--">getPeakMemoryAllocation</a></span>()</code> +<div class="block">The peak memory allocated by this Accountant.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuilder.html?is-external=true"; title="class or interface in java.lang">StringBuilder</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#indent-java.lang.StringBuilder-int-">indent</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuilder.html?is-external=true"; title="class or interface in java.lang">StringBuilder</a> sb, + int indent)</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#isDebug--">isDebug</a></span>()</code> </td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#isOverLimit--">isOverLimit</a></span>()</code> </td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#newChildAllocator-java.lang.String-long-long-">newChildAllocator</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + long initReservation, + long maxAllocation)</code> +<div class="block">Create a new child allocator.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/AllocationReservation.html" title="interface in org.apache.arrow.memory">AllocationReservation</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#newReservation--">newReservation</a></span>()</code> +<div class="block">Create an allocation reservation.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#releaseBytes-long-">releaseBytes</a></span>(long size)</code> </td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#setLimit-long-">setLimit</a></span>(long newLimit)</code> +<div class="block">Set the maximum amount of memory that can be allocated in the this Accountant before failing + an allocation.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/BaseAllocator.html#toString--">toString</a></span>()</code> </td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/BaseAllocator.html#toVerboseString--">toVerboseString</a></span>()</code> +<div class="block">Provide a verbose string of the current allocator state.</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 java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.memory.BufferAllocator"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.arrow.memory.<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></h3> +<code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getAllocatedMemory--">getAllocatedMemory</a>, <a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getHeadroom--">getHeadroom</a>, <a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getLimit--">getLimit</a>, <a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getPeakMemoryAllocation--">getPeakMemoryAllocation</a>, <a href="../../../../org/apache/arrow/memory/BufferAllocator.html#isOverLimit--">isOverLimit</a>, <a href="../../../../org/apache/arrow/memory/BufferAllocator.html#setLimit-long-">setLimit</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DEBUG_ALLOCATOR"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEBUG_ALLOCATOR</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> DEBUG_ALLOCATOR</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.arrow.memory.BaseAllocator.DEBUG_ALLOCATOR">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEBUG_LOG_LENGTH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEBUG_LOG_LENGTH</h4> +<pre>public static final int DEBUG_LOG_LENGTH</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.arrow.memory.BaseAllocator.DEBUG_LOG_LENGTH">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEBUG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEBUG</h4> +<pre>public static final boolean DEBUG</pre> +</li> +</ul> +<a name="parent"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parent</h4> +<pre>protected final org.apache.arrow.memory.Accountant parent</pre> +<div class="block">The parent allocator</div> +</li> +</ul> +<a name="reservation"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>reservation</h4> +<pre>protected final long reservation</pre> +<div class="block">The amount of memory reserved for this allocator. Releases below this amount of memory will + not be returned to the + parent Accountant until this Accountant is closed.</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BaseAllocator-org.apache.arrow.memory.AllocationListener-java.lang.String-long-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BaseAllocator</h4> +<pre>protected BaseAllocator(<a href="../../../../org/apache/arrow/memory/AllocationListener.html" title="interface in org.apache.arrow.memory">AllocationListener</a> listener, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + long initReservation, + long maxAllocation) + throws <a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html" title="class in org.apache.arrow.memory">OutOfMemoryException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html" title="class in org.apache.arrow.memory">OutOfMemoryException</a></code></dd> +</dl> +</li> +</ul> +<a name="BaseAllocator-org.apache.arrow.memory.BaseAllocator-java.lang.String-long-long-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BaseAllocator</h4> +<pre>protected BaseAllocator(<a href="../../../../org/apache/arrow/memory/BaseAllocator.html" title="class in org.apache.arrow.memory">BaseAllocator</a> parentAllocator, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + long initReservation, + long maxAllocation) + throws <a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html" title="class in org.apache.arrow.memory">OutOfMemoryException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html" title="class in org.apache.arrow.memory">OutOfMemoryException</a></code></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="indent-java.lang.StringBuilder-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>indent</h4> +<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuilder.html?is-external=true"; title="class or interface in java.lang">StringBuilder</a> indent(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/StringBuilder.html?is-external=true"; title="class or interface in java.lang">StringBuilder</a> sb, + int indent)</pre> +</li> +</ul> +<a name="isDebug--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDebug</h4> +<pre>public static boolean isDebug()</pre> +</li> +</ul> +<a name="assertOpen--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>assertOpen</h4> +<pre>public void assertOpen()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#assertOpen--">BufferAllocator</a></code></span></div> +<div class="block">Asserts (using java assertions) that the provided allocator is currently open. If assertions + are disabled, this is + a no-op.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#assertOpen--">assertOpen</a></code> in interface <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></code></dd> +</dl> +</li> +</ul> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getName()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getName--">BufferAllocator</a></code></span></div> +<div class="block">Return the name of this allocator. This is a human readable name that can help debugging. + Typically provides + coordinates about where this allocator was created</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getName--">getName</a></code> in interface <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></code></dd> +</dl> +</li> +</ul> +<a name="getEmpty--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEmpty</h4> +<pre>public <a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> getEmpty()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getEmpty--">BufferAllocator</a></code></span></div> +<div class="block">Get a reference to the empty buffer associated with this allocator. Empty buffers are + special because we don't + worry about them leaking or managing reference counts on them since they don't actually + point to any memory.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getEmpty--">getEmpty</a></code> in interface <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></code></dd> +</dl> +</li> +</ul> +<a name="buffer-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buffer</h4> +<pre>public <a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> buffer(int initialRequestSize)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#buffer-int-">BufferAllocator</a></code></span></div> +<div class="block">Allocate a new or reused buffer of the provided size. Note that the buffer may technically + be larger than the + requested size for rounding purposes. However, the buffer's capacity will be set to the + configured size.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#buffer-int-">buffer</a></code> in interface <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>initialRequestSize</code> - The size in bytes.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new ArrowBuf, or null if the request can't be satisfied</dd> +</dl> +</li> +</ul> +<a name="buffer-int-org.apache.arrow.memory.BufferManager-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buffer</h4> +<pre>public <a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> buffer(int initialRequestSize, + <a href="../../../../org/apache/arrow/memory/BufferManager.html" title="interface in org.apache.arrow.memory">BufferManager</a> manager)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#buffer-int-org.apache.arrow.memory.BufferManager-">BufferAllocator</a></code></span></div> +<div class="block">Allocate a new or reused buffer of the provided size. Note that the buffer may technically + be larger than the + requested size for rounding purposes. However, the buffer's capacity will be set to the + configured size.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#buffer-int-org.apache.arrow.memory.BufferManager-">buffer</a></code> in interface <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>initialRequestSize</code> - The size in bytes.</dd> +<dd><code>manager</code> - A buffer manager to manage reallocation.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new ArrowBuf, or null if the request can't be satisfied</dd> +</dl> +</li> +</ul> +<a name="getAsByteBufAllocator--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsByteBufAllocator</h4> +<pre>public <a href="../../../../org/apache/arrow/memory/ArrowByteBufAllocator.html" title="class in org.apache.arrow.memory">ArrowByteBufAllocator</a> getAsByteBufAllocator()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getAsByteBufAllocator--">BufferAllocator</a></code></span></div> +<div class="block">Returns the allocator this allocator falls back to when it needs more memory.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getAsByteBufAllocator--">getAsByteBufAllocator</a></code> in interface <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the underlying allocator used by this allocator</dd> +</dl> +</li> +</ul> +<a name="newChildAllocator-java.lang.String-long-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newChildAllocator</h4> +<pre>public <a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> newChildAllocator(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + long initReservation, + long maxAllocation)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#newChildAllocator-java.lang.String-long-long-">BufferAllocator</a></code></span></div> +<div class="block">Create a new child allocator.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#newChildAllocator-java.lang.String-long-long-">newChildAllocator</a></code> in interface <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the allocator.</dd> +<dd><code>initReservation</code> - the initial space reservation (obtained from this allocator)</dd> +<dd><code>maxAllocation</code> - maximum amount of space the new allocator can allocate</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the new allocator, or null if it can't be created</dd> +</dl> +</li> +</ul> +<a name="newReservation--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newReservation</h4> +<pre>public <a href="../../../../org/apache/arrow/memory/AllocationReservation.html" title="interface in org.apache.arrow.memory">AllocationReservation</a> newReservation()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#newReservation--">BufferAllocator</a></code></span></div> +<div class="block">Create an allocation reservation. A reservation is a way of building up + a request for a buffer whose size is not known in advance. See + <a href="../../../../org/apache/arrow/memory/AllocationReservation.html" title="interface in org.apache.arrow.memory"><code>AllocationReservation</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#newReservation--">newReservation</a></code> in interface <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the newly created reservation</dd> +</dl> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block">Close this Accountant. This will release any reservation bytes back to a parent Accountant.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close--"; title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#close--">close</a></code> in interface <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></code></dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/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="toVerboseString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toVerboseString</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toVerboseString()</pre> +<div class="block">Provide a verbose string of the current allocator state. Includes the state of all child + allocators, along with + historical logs of each object and including stacktraces.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#toVerboseString--">toVerboseString</a></code> in interface <code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A Verbose string of current allocator state.</dd> +</dl> +</li> +</ul> +<a name="releaseBytes-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>releaseBytes</h4> +<pre>public void releaseBytes(long size)</pre> +</li> +</ul> +<a name="isOverLimit--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isOverLimit</h4> +<pre>public boolean isOverLimit()</pre> +</li> +</ul> +<a name="getLimit--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLimit</h4> +<pre>public long getLimit()</pre> +<div class="block">Return the current limit of this Accountant.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Limit in bytes.</dd> +</dl> +</li> +</ul> +<a name="setLimit-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLimit</h4> +<pre>public void setLimit(long newLimit)</pre> +<div class="block">Set the maximum amount of memory that can be allocated in the this Accountant before failing + an allocation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>newLimit</code> - The limit in bytes.</dd> +</dl> +</li> +</ul> +<a name="getAllocatedMemory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllocatedMemory</h4> +<pre>public long getAllocatedMemory()</pre> +<div class="block">Return the current amount of allocated memory that this Accountant is managing accounting + for. Note this does not + include reservation memory that hasn't been allocated.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Currently allocate memory in bytes.</dd> +</dl> +</li> +</ul> +<a name="getPeakMemoryAllocation--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPeakMemoryAllocation</h4> +<pre>public long getPeakMemoryAllocation()</pre> +<div class="block">The peak memory allocated by this Accountant.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The peak allocated memory in bytes.</dd> +</dl> +</li> +</ul> +<a name="getHeadroom--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getHeadroom</h4> +<pre>public long getHeadroom()</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/BaseAllocator.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/ArrowByteBufAllocator.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/BaseAllocator.Reservation.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/arrow/memory/BaseAllocator.html" target="_top">Frames</a></li> +<li><a href="BaseAllocator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><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="subNavList"> +<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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/355ede33/docs/java/org/apache/arrow/memory/BoundsChecking.html ---------------------------------------------------------------------- diff --git a/docs/java/org/apache/arrow/memory/BoundsChecking.html b/docs/java/org/apache/arrow/memory/BoundsChecking.html new file mode 100644 index 0000000..5ea6e92 --- /dev/null +++ b/docs/java/org/apache/arrow/memory/BoundsChecking.html @@ -0,0 +1,241 @@ +<!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 (1.8.0_121) on Sun Apr 23 17:49:08 EDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>BoundsChecking (Apache Arrow Java Root POM 0.2.1-SNAPSHOT API)</title> +<meta name="date" content="2017-04-23"> +<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="BoundsChecking (Apache Arrow Java Root POM 0.2.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +</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/BoundsChecking.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/BaseAllocator.Verbosity.html" title="enum in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/arrow/memory/BoundsChecking.html" target="_top">Frames</a></li> +<li><a href="BoundsChecking.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li>Method</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 BoundsChecking" class="title">Class BoundsChecking</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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.BoundsChecking</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">BoundsChecking</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BoundsChecking.html#BOUNDS_CHECKING_ENABLED">BOUNDS_CHECKING_ENABLED</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="BOUNDS_CHECKING_ENABLED"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BOUNDS_CHECKING_ENABLED</h4> +<pre>public static final boolean BOUNDS_CHECKING_ENABLED</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/BoundsChecking.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/BaseAllocator.Verbosity.html" title="enum in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/arrow/memory/BoundsChecking.html" target="_top">Frames</a></li> +<li><a href="BoundsChecking.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/355ede33/docs/java/org/apache/arrow/memory/BufferAllocator.html ---------------------------------------------------------------------- diff --git a/docs/java/org/apache/arrow/memory/BufferAllocator.html b/docs/java/org/apache/arrow/memory/BufferAllocator.html new file mode 100644 index 0000000..7cb9be9 --- /dev/null +++ b/docs/java/org/apache/arrow/memory/BufferAllocator.html @@ -0,0 +1,568 @@ +<!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 (1.8.0_121) on Sun Apr 23 17:49:08 EDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>BufferAllocator (Apache Arrow Java Root POM 0.2.1-SNAPSHOT API)</title> +<meta name="date" content="2017-04-23"> +<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="BufferAllocator (Apache Arrow Java Root POM 0.2.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/BufferAllocator.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/BoundsChecking.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/BufferManager.html" title="interface in org.apache.arrow.memory"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/arrow/memory/BufferAllocator.html" target="_top">Frames</a></li> +<li><a href="BufferAllocator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.arrow.memory</div> +<h2 title="Interface BufferAllocator" class="title">Interface BufferAllocator</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/arrow/memory/BaseAllocator.html" title="class in org.apache.arrow.memory">BaseAllocator</a>, <a href="../../../../org/apache/arrow/memory/RootAllocator.html" title="class in org.apache.arrow.memory">RootAllocator</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">BufferAllocator</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a></pre> +<div class="block">Wrapper class to deal with byte buffer allocation. Ensures users only use designated methods.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#assertOpen--">assertOpen</a></span>()</code> +<div class="block">Asserts (using java assertions) that the provided allocator is currently open.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#buffer-int-">buffer</a></span>(int size)</code> +<div class="block">Allocate a new or reused buffer of the provided size.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#buffer-int-org.apache.arrow.memory.BufferManager-">buffer</a></span>(int size, + <a href="../../../../org/apache/arrow/memory/BufferManager.html" title="interface in org.apache.arrow.memory">BufferManager</a> manager)</code> +<div class="block">Allocate a new or reused buffer of the provided size.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#close--">close</a></span>()</code> +<div class="block">Close and release all buffers generated from this buffer pool.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getAllocatedMemory--">getAllocatedMemory</a></span>()</code> +<div class="block">Returns the amount of memory currently allocated from this allocator.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>io.netty.buffer.ByteBufAllocator</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getAsByteBufAllocator--">getAsByteBufAllocator</a></span>()</code> +<div class="block">Returns the allocator this allocator falls back to when it needs more memory.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getEmpty--">getEmpty</a></span>()</code> +<div class="block">Get a reference to the empty buffer associated with this allocator.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getHeadroom--">getHeadroom</a></span>()</code> +<div class="block">Returns the amount of memory that can probably be allocated at this moment + without exceeding this or any parents allocation maximum.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getLimit--">getLimit</a></span>()</code> +<div class="block">Return the current maximum limit this allocator imposes.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/BufferAllocator.html#getName--">getName</a></span>()</code> +<div class="block">Return the name of this allocator.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#getPeakMemoryAllocation--">getPeakMemoryAllocation</a></span>()</code> +<div class="block">Returns the peak amount of memory allocated from this allocator.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#isOverLimit--">isOverLimit</a></span>()</code> +<div class="block">Return whether or not this allocator (or one if its parents) is over its limits.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#newChildAllocator-java.lang.String-long-long-">newChildAllocator</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + long initReservation, + long maxAllocation)</code> +<div class="block">Create a new child allocator.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/AllocationReservation.html" title="interface in org.apache.arrow.memory">AllocationReservation</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#newReservation--">newReservation</a></span>()</code> +<div class="block">Create an allocation reservation.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/BufferAllocator.html#setLimit-long-">setLimit</a></span>(long newLimit)</code> +<div class="block">Set the maximum amount of memory this allocator is allowed to allocate.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/BufferAllocator.html#toVerboseString--">toVerboseString</a></span>()</code> +<div class="block">Return a verbose string describing this allocator.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="buffer-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buffer</h4> +<pre><a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> buffer(int size)</pre> +<div class="block">Allocate a new or reused buffer of the provided size. Note that the buffer may technically + be larger than the + requested size for rounding purposes. However, the buffer's capacity will be set to the + configured size.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>size</code> - The size in bytes.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new ArrowBuf, or null if the request can't be satisfied</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html" title="class in org.apache.arrow.memory">OutOfMemoryException</a></code> - if buffer cannot be allocated</dd> +</dl> +</li> +</ul> +<a name="buffer-int-org.apache.arrow.memory.BufferManager-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buffer</h4> +<pre><a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> buffer(int size, + <a href="../../../../org/apache/arrow/memory/BufferManager.html" title="interface in org.apache.arrow.memory">BufferManager</a> manager)</pre> +<div class="block">Allocate a new or reused buffer of the provided size. Note that the buffer may technically + be larger than the + requested size for rounding purposes. However, the buffer's capacity will be set to the + configured size.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>size</code> - The size in bytes.</dd> +<dd><code>manager</code> - A buffer manager to manage reallocation.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a new ArrowBuf, or null if the request can't be satisfied</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html" title="class in org.apache.arrow.memory">OutOfMemoryException</a></code> - if buffer cannot be allocated</dd> +</dl> +</li> +</ul> +<a name="getAsByteBufAllocator--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsByteBufAllocator</h4> +<pre>io.netty.buffer.ByteBufAllocator getAsByteBufAllocator()</pre> +<div class="block">Returns the allocator this allocator falls back to when it needs more memory.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the underlying allocator used by this allocator</dd> +</dl> +</li> +</ul> +<a name="newChildAllocator-java.lang.String-long-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newChildAllocator</h4> +<pre><a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> newChildAllocator(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + long initReservation, + long maxAllocation)</pre> +<div class="block">Create a new child allocator.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the allocator.</dd> +<dd><code>initReservation</code> - the initial space reservation (obtained from this allocator)</dd> +<dd><code>maxAllocation</code> - maximum amount of space the new allocator can allocate</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the new allocator, or null if it can't be created</dd> +</dl> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>void close()</pre> +<div class="block">Close and release all buffers generated from this buffer pool. + <p> + <p>When assertions are on, complains if there are any outstanding buffers; to avoid + that, release all buffers before the allocator is closed.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close--"; title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/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="getAllocatedMemory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllocatedMemory</h4> +<pre>long getAllocatedMemory()</pre> +<div class="block">Returns the amount of memory currently allocated from this allocator.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the amount of memory currently allocated</dd> +</dl> +</li> +</ul> +<a name="getLimit--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLimit</h4> +<pre>long getLimit()</pre> +<div class="block">Return the current maximum limit this allocator imposes.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Limit in number of bytes.</dd> +</dl> +</li> +</ul> +<a name="setLimit-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLimit</h4> +<pre>void setLimit(long newLimit)</pre> +<div class="block">Set the maximum amount of memory this allocator is allowed to allocate.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>newLimit</code> - The new Limit to apply to allocations</dd> +</dl> +</li> +</ul> +<a name="getPeakMemoryAllocation--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPeakMemoryAllocation</h4> +<pre>long getPeakMemoryAllocation()</pre> +<div class="block">Returns the peak amount of memory allocated from this allocator.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the peak amount of memory allocated</dd> +</dl> +</li> +</ul> +<a name="getHeadroom--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHeadroom</h4> +<pre>long getHeadroom()</pre> +<div class="block">Returns the amount of memory that can probably be allocated at this moment + without exceeding this or any parents allocation maximum.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Headroom in bytes</dd> +</dl> +</li> +</ul> +<a name="newReservation--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newReservation</h4> +<pre><a href="../../../../org/apache/arrow/memory/AllocationReservation.html" title="interface in org.apache.arrow.memory">AllocationReservation</a> newReservation()</pre> +<div class="block">Create an allocation reservation. A reservation is a way of building up + a request for a buffer whose size is not known in advance. See + <a href="../../../../org/apache/arrow/memory/AllocationReservation.html" title="interface in org.apache.arrow.memory"><code>AllocationReservation</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the newly created reservation</dd> +</dl> +</li> +</ul> +<a name="getEmpty--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEmpty</h4> +<pre><a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> getEmpty()</pre> +<div class="block">Get a reference to the empty buffer associated with this allocator. Empty buffers are + special because we don't + worry about them leaking or managing reference counts on them since they don't actually + point to any memory.</div> +</li> +</ul> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getName()</pre> +<div class="block">Return the name of this allocator. This is a human readable name that can help debugging. + Typically provides + coordinates about where this allocator was created</div> +</li> +</ul> +<a name="isOverLimit--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isOverLimit</h4> +<pre>boolean isOverLimit()</pre> +<div class="block">Return whether or not this allocator (or one if its parents) is over its limits. In the case + that an allocator is + over its limit, all consumers of that allocator should aggressively try to addrss the + overlimit situation.</div> +</li> +</ul> +<a name="toVerboseString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toVerboseString</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toVerboseString()</pre> +<div class="block">Return a verbose string describing this allocator. If in DEBUG mode, this will also include + relevant stacktraces + and historical logs for underlying objects</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A very verbose description of the allocator hierarchy.</dd> +</dl> +</li> +</ul> +<a name="assertOpen--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>assertOpen</h4> +<pre>void assertOpen()</pre> +<div class="block">Asserts (using java assertions) that the provided allocator is currently open. If assertions + are disabled, this is + a no-op.</div> +</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/BufferAllocator.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/BoundsChecking.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/BufferManager.html" title="interface in org.apache.arrow.memory"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/arrow/memory/BufferAllocator.html" target="_top">Frames</a></li> +<li><a href="BufferAllocator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
