http://git-wip-us.apache.org/repos/asf/arrow-site/blob/355ede33/docs/java/org/apache/arrow/memory/AllocationManager.BufferLedger.html ---------------------------------------------------------------------- diff --git a/docs/java/org/apache/arrow/memory/AllocationManager.BufferLedger.html b/docs/java/org/apache/arrow/memory/AllocationManager.BufferLedger.html new file mode 100644 index 0000000..52b7a8c --- /dev/null +++ b/docs/java/org/apache/arrow/memory/AllocationManager.BufferLedger.html @@ -0,0 +1,435 @@ +<!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>AllocationManager.BufferLedger (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="AllocationManager.BufferLedger (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}; +var tabs = {65535:["t0","All 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/AllocationManager.BufferLedger.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/AllocationManager.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/AllocationReservation.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/AllocationManager.BufferLedger.html" target="_top">Frames</a></li> +<li><a href="AllocationManager.BufferLedger.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="Class AllocationManager.BufferLedger" class="title">Class AllocationManager.BufferLedger</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.AllocationManager.BufferLedger</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/apache/arrow/memory/AllocationManager.html" title="class in org.apache.arrow.memory">AllocationManager</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">AllocationManager.BufferLedger</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> +<div class="block">The reference manager that binds an allocator manager to a particular BaseAllocator. Also + responsible for creating + a set of ArrowBufs that share a common fate and set of reference counts. + As with AllocationManager, the only reason this is public is due to ArrowBuf being in io + .netty.buffer package.</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="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>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html#decrement-int-">decrement</a></span>(int decrement)</code> +<div class="block">Decrement the ledger's reference count.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html#getAccountedSize--">getAccountedSize</a></span>()</code> +<div class="block">How much memory is accounted for by this ledger.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">AllocationManager.BufferLedger</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html#getLedgerForAllocator-org.apache.arrow.memory.BufferAllocator-">getLedgerForAllocator</a></span>(<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</code> +<div class="block">Returns the ledger associated with a particular BufferAllocator.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html#getSize--">getSize</a></span>()</code> +<div class="block">What is the total size (in bytes) of memory underlying this ledger.</div> +</td> +</tr> +<tr id="i4" 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/AllocationManager.BufferLedger.html#newArrowBuf-int-int-">newArrowBuf</a></span>(int offset, + int length)</code> +<div class="block">Create a new ArrowBuf associated with this AllocationManager and memory.</div> +</td> +</tr> +<tr id="i5" 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/AllocationManager.BufferLedger.html#newArrowBuf-int-int-org.apache.arrow.memory.BufferManager-">newArrowBuf</a></span>(int offset, + int length, + <a href="../../../../org/apache/arrow/memory/BufferManager.html" title="interface in org.apache.arrow.memory">BufferManager</a> manager)</code> +<div class="block">Create a new ArrowBuf associated with this AllocationManager and memory.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html#print-java.lang.StringBuilder-int-org.apache.arrow.memory.BaseAllocator.Verbosity-">print</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, + <a href="../../../../org/apache/arrow/memory/BaseAllocator.Verbosity.html" title="enum in org.apache.arrow.memory">BaseAllocator.Verbosity</a> verbosity)</code> +<div class="block">Print the current ledger state to a the provided StringBuilder.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html#transferBalance-org.apache.arrow.memory.AllocationManager.BufferLedger-">transferBalance</a></span>(<a href="../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">AllocationManager.BufferLedger</a> target)</code> +<div class="block">Transfer any balance the current ledger has to the target ledger.</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#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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="transferBalance-org.apache.arrow.memory.AllocationManager.BufferLedger-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transferBalance</h4> +<pre>public boolean transferBalance(<a href="../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">AllocationManager.BufferLedger</a> target)</pre> +<div class="block">Transfer any balance the current ledger has to the target ledger. In the case that the + current ledger holds no + memory, no transfer is made to the new ledger.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>target</code> - The ledger to transfer ownership account to.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Whether transfer fit within target ledgers limits.</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 void print(<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, + <a href="../../../../org/apache/arrow/memory/BaseAllocator.Verbosity.html" title="enum in org.apache.arrow.memory">BaseAllocator.Verbosity</a> verbosity)</pre> +<div class="block">Print the current ledger state to a the provided StringBuilder.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sb</code> - The StringBuilder to populate.</dd> +<dd><code>indent</code> - The level of indentation to position the data.</dd> +<dd><code>verbosity</code> - The level of verbosity to print.</dd> +</dl> +</li> +</ul> +<a name="decrement-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>decrement</h4> +<pre>public int decrement(int decrement)</pre> +<div class="block">Decrement the ledger's reference count. If the ledger is decremented to zero, this ledger + should release its + ownership back to the AllocationManager</div> +</li> +</ul> +<a name="getLedgerForAllocator-org.apache.arrow.memory.BufferAllocator-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLedgerForAllocator</h4> +<pre>public <a href="../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">AllocationManager.BufferLedger</a> getLedgerForAllocator(<a href="../../../../org/apache/arrow/memory/BufferAllocator.html" title="interface in org.apache.arrow.memory">BufferAllocator</a> allocator)</pre> +<div class="block">Returns the ledger associated with a particular BufferAllocator. If the BufferAllocator + doesn't currently have a + ledger associated with this AllocationManager, a new one is created. This is placed on + BufferLedger rather than + AllocationManager directly because ArrowBufs don't have access to AllocationManager and + they are the ones + responsible for exposing the ability to associate multiple allocators with a particular + piece of underlying + memory. Note that this will increment the reference count of this ledger by one to ensure + the ledger isn't + destroyed before use.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>allocator</code> - A BufferAllocator.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The ledger associated with the BufferAllocator.</dd> +</dl> +</li> +</ul> +<a name="newArrowBuf-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newArrowBuf</h4> +<pre>public <a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> newArrowBuf(int offset, + int length)</pre> +<div class="block">Create a new ArrowBuf associated with this AllocationManager and memory. Does not impact + reference count. + Typically used for slicing.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>offset</code> - The offset in bytes to start this new ArrowBuf.</dd> +<dd><code>length</code> - The length in bytes that this ArrowBuf will provide access to.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A new ArrowBuf that shares references with all ArrowBufs associated with this + BufferLedger</dd> +</dl> +</li> +</ul> +<a name="newArrowBuf-int-int-org.apache.arrow.memory.BufferManager-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newArrowBuf</h4> +<pre>public <a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> newArrowBuf(int offset, + int length, + <a href="../../../../org/apache/arrow/memory/BufferManager.html" title="interface in org.apache.arrow.memory">BufferManager</a> manager)</pre> +<div class="block">Create a new ArrowBuf associated with this AllocationManager and memory.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>offset</code> - The offset in bytes to start this new ArrowBuf.</dd> +<dd><code>length</code> - The length in bytes that this ArrowBuf will provide access to.</dd> +<dd><code>manager</code> - An optional BufferManager argument that can be used to manage expansion of + this ArrowBuf</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A new ArrowBuf that shares references with all ArrowBufs associated with this + BufferLedger</dd> +</dl> +</li> +</ul> +<a name="getSize--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSize</h4> +<pre>public int getSize()</pre> +<div class="block">What is the total size (in bytes) of memory underlying this ledger.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Size in bytes</dd> +</dl> +</li> +</ul> +<a name="getAccountedSize--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAccountedSize</h4> +<pre>public int getAccountedSize()</pre> +<div class="block">How much memory is accounted for by this ledger. This is either getSize() if this is the + owning ledger for the + memory or zero in the case that this is not the owning ledger associated with this memory.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Amount of accounted(owned) memory associated with this ledger.</dd> +</dl> +</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/AllocationManager.BufferLedger.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/AllocationManager.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/AllocationReservation.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/AllocationManager.BufferLedger.html" target="_top">Frames</a></li> +<li><a href="AllocationManager.BufferLedger.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>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/355ede33/docs/java/org/apache/arrow/memory/AllocationManager.html ---------------------------------------------------------------------- diff --git a/docs/java/org/apache/arrow/memory/AllocationManager.html b/docs/java/org/apache/arrow/memory/AllocationManager.html new file mode 100644 index 0000000..4216d5c --- /dev/null +++ b/docs/java/org/apache/arrow/memory/AllocationManager.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>AllocationManager (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="AllocationManager (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/AllocationManager.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/AllocationListener.html" title="interface in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.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/AllocationManager.html" target="_top">Frames</a></li> +<li><a href="AllocationManager.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>Field | </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>Field | </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 AllocationManager" class="title">Class AllocationManager</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.AllocationManager</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">AllocationManager</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> +<div class="block">Manages the relationship between one or more allocators and a particular UDLE. Ensures that + one allocator owns the + memory that multiple allocators may be referencing. Manages a BufferLedger between each of its + associated allocators. + This class is also responsible for managing when memory is allocated and returned to the + Netty-based + PooledByteBufAllocatorL. + <p> + The only reason that this isn't package private is we're forced to put ArrowBuf in Netty's + package which need access + to these objects or methods. + <p> + Threading: AllocationManager manages thread-safety internally. Operations within the context + of a single BufferLedger + are lockless in nature and can be leveraged by multiple threads. Operations that cross the + context of two ledgers + will acquire a lock on the AllocationManager instance. Important note, there is one + AllocationManager per + UnsafeDirectLittleEndian buffer allocation. As such, there will be thousands of these in a + typical query. The + contention of acquiring a lock on AllocationManager should be very low.</div> +</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>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">AllocationManager.BufferLedger</a></span></code> +<div class="block">The reference manager that binds an allocator manager to a particular BaseAllocator.</div> +</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> +<!-- ========= 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/AllocationManager.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/AllocationListener.html" title="interface in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.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/AllocationManager.html" target="_top">Frames</a></li> +<li><a href="AllocationManager.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>Field | </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>Field | </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/AllocationReservation.html ---------------------------------------------------------------------- diff --git a/docs/java/org/apache/arrow/memory/AllocationReservation.html b/docs/java/org/apache/arrow/memory/AllocationReservation.html new file mode 100644 index 0000000..86eedda --- /dev/null +++ b/docs/java/org/apache/arrow/memory/AllocationReservation.html @@ -0,0 +1,380 @@ +<!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>AllocationReservation (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="AllocationReservation (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}; +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/AllocationReservation.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/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/AllocatorClosedException.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/AllocationReservation.html" target="_top">Frames</a></li> +<li><a href="AllocationReservation.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 AllocationReservation" class="title">Interface AllocationReservation</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.Reservation.html" title="class in org.apache.arrow.memory">BaseAllocator.Reservation</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">AllocationReservation</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">Supports cumulative allocation reservation. Clients may increase the size of the reservation + repeatedly until they + call for an allocation of the current total size. The reservation can only be used once, and + will throw an exception + if it is used more than once. + <p> + For the purposes of airtight memory accounting, the reservation must be close()d whether it is + used or not. + This is not threadsafe.</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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/AllocationReservation.html#add-int-">add</a></span>(int nBytes)</code> +<div class="block">Add to the current reservation.</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/AllocationReservation.html#allocateBuffer--">allocateBuffer</a></span>()</code> +<div class="block">Allocate a buffer whose size is the total of all the add()s made.</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/AllocationReservation.html#close--">close</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/AllocationReservation.html#getSize--">getSize</a></span>()</code> +<div class="block">Get the current size of the reservation (the sum of all the add()s).</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/AllocationReservation.html#isClosed--">isClosed</a></span>()</code> +<div class="block">Return whether or not the reservation has been closed.</div> +</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/AllocationReservation.html#isUsed--">isUsed</a></span>()</code> +<div class="block">Return whether or not the reservation has been used.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/AllocationReservation.html#reserve-int-">reserve</a></span>(int nBytes)</code> +<div class="block">Requests a reservation of additional space.</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="add-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre>boolean add(int nBytes)</pre> +<div class="block">Add to the current reservation. + <p> + <p>Adding may fail if the allocator is not allowed to consume any more space.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>nBytes</code> - the number of bytes to add</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the addition is possible, false otherwise</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if called after buffer() is used to allocate the reservation</dd> +</dl> +</li> +</ul> +<a name="reserve-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reserve</h4> +<pre>boolean reserve(int nBytes)</pre> +<div class="block">Requests a reservation of additional space. + <p> + <p>The implementation of the allocator's inner class provides this.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>nBytes</code> - the amount to reserve</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the reservation can be satisfied, false otherwise</dd> +</dl> +</li> +</ul> +<a name="allocateBuffer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>allocateBuffer</h4> +<pre><a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> allocateBuffer()</pre> +<div class="block">Allocate a buffer whose size is the total of all the add()s made. + <p> + <p>The allocation request can still fail, even if the amount of space + requested is available, if the allocation cannot be made contiguously.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the buffer, or null, if the request cannot be satisfied</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if called called more than once</dd> +</dl> +</li> +</ul> +<a name="getSize--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSize</h4> +<pre>int getSize()</pre> +<div class="block">Get the current size of the reservation (the sum of all the add()s).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>size of the current reservation</dd> +</dl> +</li> +</ul> +<a name="isUsed--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUsed</h4> +<pre>boolean isUsed()</pre> +<div class="block">Return whether or not the reservation has been used.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether or not the reservation has been used</dd> +</dl> +</li> +</ul> +<a name="isClosed--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClosed</h4> +<pre>boolean isClosed()</pre> +<div class="block">Return whether or not the reservation has been closed.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether or not the reservation has been closed</dd> +</dl> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>void close()</pre> +<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> +</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/AllocationReservation.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/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/AllocatorClosedException.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/AllocationReservation.html" target="_top">Frames</a></li> +<li><a href="AllocationReservation.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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/355ede33/docs/java/org/apache/arrow/memory/AllocatorClosedException.html ---------------------------------------------------------------------- diff --git a/docs/java/org/apache/arrow/memory/AllocatorClosedException.html b/docs/java/org/apache/arrow/memory/AllocatorClosedException.html new file mode 100644 index 0000000..9e02f9a --- /dev/null +++ b/docs/java/org/apache/arrow/memory/AllocatorClosedException.html @@ -0,0 +1,275 @@ +<!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>AllocatorClosedException (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="AllocatorClosedException (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/AllocatorClosedException.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/AllocationReservation.html" title="interface in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/ArrowByteBufAllocator.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/AllocatorClosedException.html" target="_top">Frames</a></li> +<li><a href="AllocatorClosedException.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 AllocatorClosedException" class="title">Class AllocatorClosedException</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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true"; title="class or interface in java.lang">java.lang.RuntimeException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.arrow.memory.AllocatorClosedException</li> +</ul> +</li> +</ul> +</li> +</ul> +</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/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">AllocatorClosedException</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true"; title="class or interface in java.lang">RuntimeException</a></pre> +<div class="block">Exception thrown when a closed BufferAllocator is used. Note + this is an unchecked exception.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#org.apache.arrow.memory.AllocatorClosedException">Serialized Form</a></dd> +</dl> +</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"> </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/AllocatorClosedException.html#AllocatorClosedException-java.lang.String-">AllocatorClosedException</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> message)</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.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-"; title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--"; title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getCause--"; title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--"; title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getMessage--"; title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--"; title="class or inter face in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--"; title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-"; title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lan g/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a></code></li> +</ul> +<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> +</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="AllocatorClosedException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AllocatorClosedException</h4> +<pre>public AllocatorClosedException(<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> message)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>message</code> - string associated with the cause</dd> +</dl> +</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/AllocatorClosedException.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/AllocationReservation.html" title="interface in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/ArrowByteBufAllocator.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/AllocatorClosedException.html" target="_top">Frames</a></li> +<li><a href="AllocatorClosedException.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><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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>
