blob: 02c34a2e66c25661cc925e07795a8ab50d2211fb [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>Communicator (Heron Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-03-01">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Communicator (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10};
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";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.heron.common.basics</a></div>
<h2 title="Class Communicator" class="title">Class Communicator&lt;E&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.heron.common.basics.Communicator&lt;E&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">Communicator&lt;E&gt;</span>
extends java.lang.Object</pre>
<div class="block">An soft bounded unblocking queue based on LinkedTransferQueue.
This queue will has a soft bound, which mean you could check the remainingCapacity() to decide
whether you could continuously offer items. However, the buffer underneath is an unbounded
LinkedTransferQueue, so you could still offer items even if remainingCapacity() &lt;= 0.
<p>
We use an unbound queue since for every time user's bolt's executing or spout's emitting tuples,
it is possible that unbounded # of tuples could be generated. And we could not stop them since
the logic is inside their jars. So in order to avoid enqueue failure, we need an unbound queue.
<p>
However, in order to avoid GC issues and keep high performance, we would have a dynamical tuning
Queue's expected capacity, see updateExpectedAvailableCapacity() below.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Communicator</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.heron.common.basics.WakeableLooper,org.apache.heron.common.basics.WakeableLooper)">Communicator</a></span>&#8203;(<a href="WakeableLooper.html" title="class in org.apache.heron.common.basics">WakeableLooper</a>&nbsp;producer,
<a href="WakeableLooper.html" title="class in org.apache.heron.common.basics">WakeableLooper</a>&nbsp;consumer)</code></th>
<td class="colLast">
<div class="block">Constructor for Communicator</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#drainTo(java.util.Collection)">drainTo</a></span>&#8203;(java.util.Collection&lt;? super <a href="Communicator.html" title="type parameter in Communicator">E</a>&gt;&nbsp;c)</code></th>
<td class="colLast">
<div class="block">Removes all available elements from this queue and adds them to the given collection.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#drainTo(java.util.Collection,int)">drainTo</a></span>&#8203;(java.util.Collection&lt;? super <a href="Communicator.html" title="type parameter in Communicator">E</a>&gt;&nbsp;c,
int&nbsp;maxElements)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#expectMoreItems()">expectMoreItems</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#expectNoMoreItems()">expectNoMoreItems</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCapacity()">getCapacity</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExpectedAvailableCapacity()">getExpectedAvailableCapacity</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#informConsumer()">informConsumer</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#informProducer()">informProducer</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init(int,int,double)">init</a></span>&#8203;(int&nbsp;ipcapacity,
int&nbsp;ipexpectedQueueSize,
double&nbsp;ipcurrentSampleWeight)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmpty()">isEmpty</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#offer(E)">offer</a></span>&#8203;(<a href="Communicator.html" title="type parameter in Communicator">E</a>&nbsp;e)</code></th>
<td class="colLast">
<div class="block">Since it is an unbounded queue, the offer will always return true.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="Communicator.html" title="type parameter in Communicator">E</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#peek()">peek</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="Communicator.html" title="type parameter in Communicator">E</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#poll()">poll</a></span>()</code></th>
<td class="colLast">
<div class="block">Check if there is any item in the queue</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remainingCapacity()">remainingCapacity</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConsumer(org.apache.heron.common.basics.WakeableLooper)">setConsumer</a></span>&#8203;(<a href="WakeableLooper.html" title="class in org.apache.heron.common.basics">WakeableLooper</a>&nbsp;consumer)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProducer(org.apache.heron.common.basics.WakeableLooper)">setProducer</a></span>&#8203;(<a href="WakeableLooper.html" title="class in org.apache.heron.common.basics">WakeableLooper</a>&nbsp;producer)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#size()">size</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the number of items in queue</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateExpectedAvailableCapacity()">updateExpectedAvailableCapacity</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.heron.common.basics.WakeableLooper,org.apache.heron.common.basics.WakeableLooper)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Communicator</h4>
<pre>public&nbsp;Communicator&#8203;(<a href="WakeableLooper.html" title="class in org.apache.heron.common.basics">WakeableLooper</a>&nbsp;producer,
<a href="WakeableLooper.html" title="class in org.apache.heron.common.basics">WakeableLooper</a>&nbsp;consumer)</pre>
<div class="block">Constructor for Communicator</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>producer</code> - would be waken up when items are consumed from queue,
or set it to null if we don't want producer to be waken up</dd>
<dd><code>consumer</code> - would be waken up when items are produced into queue,
or set it to null if we don't want consumer to be waken up</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Communicator</h4>
<pre>public&nbsp;Communicator()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="setProducer(org.apache.heron.common.basics.WakeableLooper)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProducer</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setProducer&#8203;(<a href="WakeableLooper.html" title="class in org.apache.heron.common.basics">WakeableLooper</a>&nbsp;producer)</pre>
</li>
</ul>
<a id="setConsumer(org.apache.heron.common.basics.WakeableLooper)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConsumer</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setConsumer&#8203;(<a href="WakeableLooper.html" title="class in org.apache.heron.common.basics">WakeableLooper</a>&nbsp;consumer)</pre>
</li>
</ul>
<a id="init(int,int,double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;init&#8203;(int&nbsp;ipcapacity,
int&nbsp;ipexpectedQueueSize,
double&nbsp;ipcurrentSampleWeight)</pre>
</li>
</ul>
<a id="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;size()</pre>
<div class="block">Get the number of items in queue</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of items in queue</dd>
</dl>
</li>
</ul>
<a id="remainingCapacity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remainingCapacity</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;remainingCapacity()</pre>
</li>
</ul>
<a id="poll()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>poll</h4>
<pre class="methodSignature">public&nbsp;<a href="Communicator.html" title="type parameter in Communicator">E</a>&nbsp;poll()</pre>
<div class="block">Check if there is any item in the queue</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>null if there is no item inside the queue</dd>
</dl>
</li>
</ul>
<a id="offer(java.lang.Object)">
<!-- -->
</a><a id="offer(E)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offer</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;offer&#8203;(<a href="Communicator.html" title="type parameter in Communicator">E</a>&nbsp;e)</pre>
<div class="block">Since it is an unbounded queue, the offer will always return true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>e</code> - Item to be inserted</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true : inserted successfully</dd>
</dl>
</li>
</ul>
<a id="peek()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>peek</h4>
<pre class="methodSignature">public&nbsp;<a href="Communicator.html" title="type parameter in Communicator">E</a>&nbsp;peek()</pre>
</li>
</ul>
<a id="getCapacity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCapacity</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getCapacity()</pre>
</li>
</ul>
<a id="isEmpty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isEmpty()</pre>
</li>
</ul>
<a id="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;clear()</pre>
</li>
</ul>
<a id="drainTo(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drainTo</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;drainTo&#8203;(java.util.Collection&lt;? super <a href="Communicator.html" title="type parameter in Communicator">E</a>&gt;&nbsp;c)</pre>
<div class="block">Removes all available elements from this queue and adds them to the given collection.
This operation may be more efficient than repeatedly polling this queue.
A failure encountered while attempting to add elements to collection c may result in elements being in neither,
either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in IllegalArgumentException.
Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of elements transferred</dd>
</dl>
</li>
</ul>
<a id="drainTo(java.util.Collection,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drainTo</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;drainTo&#8203;(java.util.Collection&lt;? super <a href="Communicator.html" title="type parameter in Communicator">E</a>&gt;&nbsp;c,
int&nbsp;maxElements)</pre>
</li>
</ul>
<a id="updateExpectedAvailableCapacity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateExpectedAvailableCapacity</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;updateExpectedAvailableCapacity()</pre>
</li>
</ul>
<a id="getExpectedAvailableCapacity()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpectedAvailableCapacity</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getExpectedAvailableCapacity()</pre>
</li>
</ul>
<a id="expectNoMoreItems()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>expectNoMoreItems</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;expectNoMoreItems()</pre>
</li>
</ul>
<a id="expectMoreItems()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>expectMoreItems</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;expectMoreItems()</pre>
</li>
</ul>
<a id="informProducer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>informProducer</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;informProducer()</pre>
</li>
</ul>
<a id="informConsumer()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>informConsumer</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;informConsumer()</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>