http://git-wip-us.apache.org/repos/asf/arrow-site/blob/355ede33/docs/java/org/apache/arrow/memory/BufferManager.html ---------------------------------------------------------------------- diff --git a/docs/java/org/apache/arrow/memory/BufferManager.html b/docs/java/org/apache/arrow/memory/BufferManager.html new file mode 100644 index 0000000..29c9dc6 --- /dev/null +++ b/docs/java/org/apache/arrow/memory/BufferManager.html @@ -0,0 +1,311 @@ +<!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>BufferManager (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="BufferManager (Apache Arrow Java Root POM 0.2.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":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/BufferManager.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/BufferAllocator.html" title="interface in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/OutOfMemoryException.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/BufferManager.html" target="_top">Frames</a></li> +<li><a href="BufferManager.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 BufferManager" class="title">Interface BufferManager</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> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">BufferManager</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">Manages a list of <a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer"><code>ArrowBuf</code></a>s that can be reallocated as needed. Upon + re-allocation the old buffer will be freed. Managing a list of these buffers + prevents some parts of the system from needing to define a correct location + to place the final call to free them. + <p> + The current uses of these types of buffers are within the pluggable components of Drill. + In UDFs, memory management should not be a concern. We provide access to re-allocatable + ArrowBufs to give UDF writers general purpose buffers we can account for. To prevent the need + for UDFs to contain boilerplate to close all of the buffers they request, this list + is tracked at a higher level and all of the buffers are freed once we are sure that + the code depending on them is done executing (currently <code>FragmentContext</code> + and <code>QueryContext</code>.</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/BufferManager.html#close--">close</a></span>()</code> </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/BufferManager.html#getManagedBuffer--">getManagedBuffer</a></span>()</code> +<div class="block">Get a managed buffer of indeterminate 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/BufferManager.html#getManagedBuffer-int-">getManagedBuffer</a></span>(int size)</code> +<div class="block">Get a managed buffer of at least a certain size.</div> +</td> +</tr> +<tr id="i3" 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/BufferManager.html#replace-io.netty.buffer.ArrowBuf-int-">replace</a></span>(<a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> old, + int newSize)</code> +<div class="block">Replace an old buffer with a new version at least of the provided size.</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="replace-io.netty.buffer.ArrowBuf-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replace</h4> +<pre><a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> replace(<a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> old, + int newSize)</pre> +<div class="block">Replace an old buffer with a new version at least of the provided size. Does not copy data.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>old</code> - Old Buffer that the user is no longer going to use.</dd> +<dd><code>newSize</code> - Size of new replacement buffer.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A new version of the buffer.</dd> +</dl> +</li> +</ul> +<a name="getManagedBuffer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getManagedBuffer</h4> +<pre><a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> getManagedBuffer()</pre> +<div class="block">Get a managed buffer of indeterminate size.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A buffer.</dd> +</dl> +</li> +</ul> +<a name="getManagedBuffer-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getManagedBuffer</h4> +<pre><a href="../../../../io/netty/buffer/ArrowBuf.html" title="class in io.netty.buffer">ArrowBuf</a> getManagedBuffer(int size)</pre> +<div class="block">Get a managed buffer of at least a certain size.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>size</code> - The desired size</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A buffer</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/BufferManager.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/BufferAllocator.html" title="interface in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/OutOfMemoryException.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/BufferManager.html" target="_top">Frames</a></li> +<li><a href="BufferManager.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/OutOfMemoryException.html ---------------------------------------------------------------------- diff --git a/docs/java/org/apache/arrow/memory/OutOfMemoryException.html b/docs/java/org/apache/arrow/memory/OutOfMemoryException.html new file mode 100644 index 0000000..10ddedf --- /dev/null +++ b/docs/java/org/apache/arrow/memory/OutOfMemoryException.html @@ -0,0 +1,325 @@ +<!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>OutOfMemoryException (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="OutOfMemoryException (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/OutOfMemoryException.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/BufferManager.html" title="interface in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/RootAllocator.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/OutOfMemoryException.html" target="_top">Frames</a></li> +<li><a href="OutOfMemoryException.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 OutOfMemoryException" class="title">Class OutOfMemoryException</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.OutOfMemoryException</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">OutOfMemoryException</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> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#org.apache.arrow.memory.OutOfMemoryException">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/OutOfMemoryException.html#OutOfMemoryException--">OutOfMemoryException</a></span>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html#OutOfMemoryException-java.lang.String-">OutOfMemoryException</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> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html#OutOfMemoryException-java.lang.String-java.lang.Throwable-">OutOfMemoryException</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, + <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> cause)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html#OutOfMemoryException-java.lang.String-java.lang.Throwable-boolean-boolean-">OutOfMemoryException</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, + <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> cause, + boolean enableSuppression, + boolean writableStackTrace)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/OutOfMemoryException.html#OutOfMemoryException-java.lang.Throwable-">OutOfMemoryException</a></span>(<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> cause)</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="OutOfMemoryException--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OutOfMemoryException</h4> +<pre>public OutOfMemoryException()</pre> +</li> +</ul> +<a name="OutOfMemoryException-java.lang.String-java.lang.Throwable-boolean-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OutOfMemoryException</h4> +<pre>public OutOfMemoryException(<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, + <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> cause, + boolean enableSuppression, + boolean writableStackTrace)</pre> +</li> +</ul> +<a name="OutOfMemoryException-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OutOfMemoryException</h4> +<pre>public OutOfMemoryException(<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, + <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> cause)</pre> +</li> +</ul> +<a name="OutOfMemoryException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OutOfMemoryException</h4> +<pre>public OutOfMemoryException(<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> +</li> +</ul> +<a name="OutOfMemoryException-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>OutOfMemoryException</h4> +<pre>public OutOfMemoryException(<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> cause)</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/OutOfMemoryException.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/BufferManager.html" title="interface in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/arrow/memory/RootAllocator.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/OutOfMemoryException.html" target="_top">Frames</a></li> +<li><a href="OutOfMemoryException.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> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/355ede33/docs/java/org/apache/arrow/memory/RootAllocator.html ---------------------------------------------------------------------- diff --git a/docs/java/org/apache/arrow/memory/RootAllocator.html b/docs/java/org/apache/arrow/memory/RootAllocator.html new file mode 100644 index 0000000..6bcf24d --- /dev/null +++ b/docs/java/org/apache/arrow/memory/RootAllocator.html @@ -0,0 +1,531 @@ +<!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>RootAllocator (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="RootAllocator (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/RootAllocator.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/OutOfMemoryException.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/arrow/memory/RootAllocator.html" target="_top">Frames</a></li> +<li><a href="RootAllocator.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 RootAllocator" class="title">Class RootAllocator</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="../../../../org/apache/arrow/memory/BaseAllocator.html" title="class in org.apache.arrow.memory">org.apache.arrow.memory.BaseAllocator</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.arrow.memory.RootAllocator</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/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> +<hr> +<br> +<pre>public class <span class="typeNameLabel">RootAllocator</span> +extends <a href="../../../../org/apache/arrow/memory/BaseAllocator.html" title="class in org.apache.arrow.memory">BaseAllocator</a></pre> +<div class="block">The root allocator for using direct memory inside a Drillbit. Supports creating a + tree of descendant child allocators.</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>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> +</table> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.arrow.memory.BaseAllocator"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.apache.arrow.memory.<a href="../../../../org/apache/arrow/memory/BaseAllocator.html" title="class in org.apache.arrow.memory">BaseAllocator</a></h3> +<code><a href="../../../../org/apache/arrow/memory/BaseAllocator.Reservation.html" title="class in org.apache.arrow.memory">BaseAllocator.Reservation</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.Verbosity.html" title="enum in org.apache.arrow.memory">BaseAllocator.Verbosity</a></code></li> +</ul> +</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>protected org.apache.arrow.memory.Accountant</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/RootAllocator.html#parent">parent</a></span></code> +<div class="block">The parent allocator</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/RootAllocator.html#reservation">reservation</a></span></code> +<div class="block">The amount of memory reserved for this allocator.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.arrow.memory.BaseAllocator"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.arrow.memory.<a href="../../../../org/apache/arrow/memory/BaseAllocator.html" title="class in org.apache.arrow.memory">BaseAllocator</a></h3> +<code><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#DEBUG">DEBUG</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#DEBUG_ALLOCATOR">DEBUG_ALLOCATOR</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#DEBUG_LOG_LENGTH">DEBUG_LOG_LENGTH</a></code></li> +</ul> +</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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/RootAllocator.html#RootAllocator-org.apache.arrow.memory.AllocationListener-long-">RootAllocator</a></span>(<a href="../../../../org/apache/arrow/memory/AllocationListener.html" title="interface in org.apache.arrow.memory">AllocationListener</a> listener, + long limit)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/RootAllocator.html#RootAllocator-long-">RootAllocator</a></span>(long limit)</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="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>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/RootAllocator.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="i1" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/RootAllocator.html#getHeadroom--">getHeadroom</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/RootAllocator.html#getLimit--">getLimit</a></span>()</code> +<div class="block">Return the current limit of this Accountant.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/RootAllocator.html#getPeakMemoryAllocation--">getPeakMemoryAllocation</a></span>()</code> +<div class="block">The peak memory allocated by this Accountant.</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/RootAllocator.html#isOverLimit--">isOverLimit</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/RootAllocator.html#releaseBytes-long-">releaseBytes</a></span>(long size)</code> </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/RootAllocator.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="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/arrow/memory/RootAllocator.html#verify--">verify</a></span>()</code> +<div class="block">Verify the accounting state of the allocation system.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.memory.BaseAllocator"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.arrow.memory.<a href="../../../../org/apache/arrow/memory/BaseAllocator.html" title="class in org.apache.arrow.memory">BaseAllocator</a></h3> +<code><a href="../../../../org/apache/arrow/memory/BaseAllocator.html#assertOpen--">assertOpen</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#buffer-int-">buffer</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#buffer-int-org.apache.arrow.memory.BufferManager-">buffer</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#close--">close</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#getAsByteBufAllocator--">getAsByteBufAllocator</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#getEmpty--">getEmpty</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#getName--">getName</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#indent-java.lang.StringBuilder-int-">indent</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#isDebug--">isDebug</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#newChildAllocator-java.lang.String-lon g-long-">newChildAllocator</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#newReservation--">newReservation</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#toString--">toString</a>, <a href="../../../../org/apache/arrow/memory/BaseAllocator.html#toVerboseString--">toVerboseString</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> +<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="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="RootAllocator-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RootAllocator</h4> +<pre>public RootAllocator(long limit)</pre> +</li> +</ul> +<a name="RootAllocator-org.apache.arrow.memory.AllocationListener-long-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RootAllocator</h4> +<pre>public RootAllocator(<a href="../../../../org/apache/arrow/memory/AllocationListener.html" title="interface in org.apache.arrow.memory">AllocationListener</a> listener, + long limit)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="verify--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>verify</h4> +<pre>public void verify()</pre> +<div class="block">Verify the accounting state of the allocation system.</div> +</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/RootAllocator.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/OutOfMemoryException.html" title="class in org.apache.arrow.memory"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/arrow/memory/RootAllocator.html" target="_top">Frames</a></li> +<li><a href="RootAllocator.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/class-use/AllocationListener.html ---------------------------------------------------------------------- diff --git a/docs/java/org/apache/arrow/memory/class-use/AllocationListener.html b/docs/java/org/apache/arrow/memory/class-use/AllocationListener.html new file mode 100644 index 0000000..95b603b --- /dev/null +++ b/docs/java/org/apache/arrow/memory/class-use/AllocationListener.html @@ -0,0 +1,189 @@ +<!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:50:08 EDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Uses of Interface org.apache.arrow.memory.AllocationListener (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="Uses of Interface org.apache.arrow.memory.AllocationListener (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><a href="../../../../../org/apache/arrow/memory/AllocationListener.html" title="interface in org.apache.arrow.memory">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/arrow/memory/class-use/AllocationListener.html" target="_top">Frames</a></li> +<li><a href="AllocationListener.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface org.apache.arrow.memory.AllocationListener" class="title">Uses of Interface<br>org.apache.arrow.memory.AllocationListener</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../org/apache/arrow/memory/AllocationListener.html" title="interface in org.apache.arrow.memory">AllocationListener</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.arrow.memory">org.apache.arrow.memory</a></td> +<td class="colLast"> +<div class="block">Memory Allocation, Account and Management + + See the README.md file in this directory for detailed information about Arrow's memory + allocation subsystem.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.arrow.memory"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../org/apache/arrow/memory/AllocationListener.html" title="interface in org.apache.arrow.memory">AllocationListener</a> in <a href="../../../../../org/apache/arrow/memory/package-summary.html">org.apache.arrow.memory</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing fields, and an explanation"> +<caption><span>Fields in <a href="../../../../../org/apache/arrow/memory/package-summary.html">org.apache.arrow.memory</a> declared as <a href="../../../../../org/apache/arrow/memory/AllocationListener.html" title="interface in org.apache.arrow.memory">AllocationListener</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/arrow/memory/AllocationListener.html" title="interface in org.apache.arrow.memory">AllocationListener</a></code></td> +<td class="colLast"><span class="typeNameLabel">AllocationListener.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/memory/AllocationListener.html#NOOP">NOOP</a></span></code> </td> +</tr> +</tbody> +</table> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../org/apache/arrow/memory/package-summary.html">org.apache.arrow.memory</a> with parameters of type <a href="../../../../../org/apache/arrow/memory/AllocationListener.html" title="interface in org.apache.arrow.memory">AllocationListener</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<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="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/arrow/memory/RootAllocator.html#RootAllocator-org.apache.arrow.memory.AllocationListener-long-">RootAllocator</a></span>(<a href="../../../../../org/apache/arrow/memory/AllocationListener.html" title="interface in org.apache.arrow.memory">AllocationListener</a> listener, + long limit)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../org/apache/arrow/memory/AllocationListener.html" title="interface in org.apache.arrow.memory">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/arrow/memory/class-use/AllocationListener.html" target="_top">Frames</a></li> +<li><a href="AllocationListener.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> +<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/class-use/AllocationManager.BufferLedger.html ---------------------------------------------------------------------- diff --git a/docs/java/org/apache/arrow/memory/class-use/AllocationManager.BufferLedger.html b/docs/java/org/apache/arrow/memory/class-use/AllocationManager.BufferLedger.html new file mode 100644 index 0000000..2c12df1 --- /dev/null +++ b/docs/java/org/apache/arrow/memory/class-use/AllocationManager.BufferLedger.html @@ -0,0 +1,215 @@ +<!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:50:08 EDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Uses of Class org.apache.arrow.memory.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="Uses of Class org.apache.arrow.memory.AllocationManager.BufferLedger (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><a href="../../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/arrow/memory/class-use/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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.arrow.memory.AllocationManager.BufferLedger" class="title">Uses of Class<br>org.apache.arrow.memory.AllocationManager.BufferLedger</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">AllocationManager.BufferLedger</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#io.netty.buffer">io.netty.buffer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.arrow.memory">org.apache.arrow.memory</a></td> +<td class="colLast"> +<div class="block">Memory Allocation, Account and Management + + See the README.md file in this directory for detailed information about Arrow's memory + allocation subsystem.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="io.netty.buffer"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">AllocationManager.BufferLedger</a> in <a href="../../../../../io/netty/buffer/package-summary.html">io.netty.buffer</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../io/netty/buffer/package-summary.html">io.netty.buffer</a> with parameters of type <a href="../../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">AllocationManager.BufferLedger</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../io/netty/buffer/ArrowBuf.html#ArrowBuf-java.util.concurrent.atomic.AtomicInteger-org.apache.arrow.memory.AllocationManager.BufferLedger-io.netty.buffer.UnsafeDirectLittleEndian-org.apache.arrow.memory.BufferManager-org.apache.arrow.memory.ArrowByteBufAllocator-int-int-boolean-">ArrowBuf</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/atomic/AtomicInteger.html?is-external=true"; title="class or interface in java.util.concurrent.atomic">AtomicInteger</a> refCnt, + <a href="../../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">AllocationManager.BufferLedger</a> ledger, + <a href="../../../../../io/netty/buffer/UnsafeDirectLittleEndian.html" title="class in io.netty.buffer">UnsafeDirectLittleEndian</a> byteBuf, + <a href="../../../../../org/apache/arrow/memory/BufferManager.html" title="interface in org.apache.arrow.memory">BufferManager</a> manager, + <a href="../../../../../org/apache/arrow/memory/ArrowByteBufAllocator.html" title="class in org.apache.arrow.memory">ArrowByteBufAllocator</a> alloc, + int offset, + int length, + boolean isEmpty)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.arrow.memory"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">AllocationManager.BufferLedger</a> in <a href="../../../../../org/apache/arrow/memory/package-summary.html">org.apache.arrow.memory</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../org/apache/arrow/memory/package-summary.html">org.apache.arrow.memory</a> that return <a href="../../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">AllocationManager.BufferLedger</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr 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"><span class="typeNameLabel">AllocationManager.BufferLedger.</span><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> +</tbody> +</table> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../org/apache/arrow/memory/package-summary.html">org.apache.arrow.memory</a> with parameters of type <a href="../../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">AllocationManager.BufferLedger</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="typeNameLabel">AllocationManager.BufferLedger.</span><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> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../org/apache/arrow/memory/AllocationManager.BufferLedger.html" title="class in org.apache.arrow.memory">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/arrow/memory/class-use/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> +<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/class-use/AllocationManager.html ---------------------------------------------------------------------- diff --git a/docs/java/org/apache/arrow/memory/class-use/AllocationManager.html b/docs/java/org/apache/arrow/memory/class-use/AllocationManager.html new file mode 100644 index 0000000..96cfdcc --- /dev/null +++ b/docs/java/org/apache/arrow/memory/class-use/AllocationManager.html @@ -0,0 +1,126 @@ +<!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:50:08 EDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Uses of Class org.apache.arrow.memory.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="Uses of Class org.apache.arrow.memory.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><a href="../../../../../org/apache/arrow/memory/AllocationManager.html" title="class in org.apache.arrow.memory">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/arrow/memory/class-use/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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.arrow.memory.AllocationManager" class="title">Uses of Class<br>org.apache.arrow.memory.AllocationManager</h2> +</div> +<div class="classUseContainer">No usage of org.apache.arrow.memory.AllocationManager</div> +<!-- ======= 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><a href="../../../../../org/apache/arrow/memory/AllocationManager.html" title="class in org.apache.arrow.memory">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/arrow/memory/class-use/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> +<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>
