blob: b29bdfe60c21944ec9ce572f161a5d2280e559f2 [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>BoltMetrics (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="BoltMetrics (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};
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.utils.metrics</a></div>
<h2 title="Class BoltMetrics" class="title">Class BoltMetrics</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.heron.common.utils.metrics.BoltMetrics</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="ComponentMetrics.html" title="interface in org.apache.heron.common.utils.metrics">ComponentMetrics</a></code>, <code><a href="IBoltMetrics.html" title="interface in org.apache.heron.common.utils.metrics">IBoltMetrics</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">BoltMetrics</span>
extends java.lang.Object
implements <a href="IBoltMetrics.html" title="interface in org.apache.heron.common.utils.metrics">IBoltMetrics</a></pre>
<div class="block">Bolt's metrics to be collect
We need to:
1. Define the metrics to be collected
2. New them in the constructor
3. Register them in registerMetrics(...) by using MetricsCollector's registerMetric(...)
4. Expose methods which could be called externally to change the value of metrics
This is a fast bolt metrics object and it is NOT used in heron core. To use this
metrics object, go to BoltInstance.java and replace "new FullBoltMetrcs" to "new BoltMetrics"</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()">BoltMetrics</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#ackedTuple(java.lang.String,java.lang.String,long)">ackedTuple</a></span>&#8203;(java.lang.String&nbsp;streamId,
java.lang.String&nbsp;sourceComponent,
long&nbsp;latency)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addTupleToQueue(int)">addTupleToQueue</a></span>&#8203;(int&nbsp;size)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deserializeDataTuple(java.lang.String,java.lang.String,long)">deserializeDataTuple</a></span>&#8203;(java.lang.String&nbsp;streamId,
java.lang.String&nbsp;sourceComponent,
long&nbsp;latency)</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="#emittedTuple(java.lang.String)">emittedTuple</a></span>&#8203;(java.lang.String&nbsp;streamId)</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="#executeTuple(java.lang.String,java.lang.String,long)">executeTuple</a></span>&#8203;(java.lang.String&nbsp;streamId,
java.lang.String&nbsp;sourceComponent,
long&nbsp;latency)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#failedTuple(java.lang.String,java.lang.String,long)">failedTuple</a></span>&#8203;(java.lang.String&nbsp;streamId,
java.lang.String&nbsp;sourceComponent,
long&nbsp;latency)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initMultiCountMetrics(org.apache.heron.common.utils.misc.PhysicalPlanHelper)">initMultiCountMetrics</a></span>&#8203;(<a href="../misc/PhysicalPlanHelper.html" title="class in org.apache.heron.common.utils.misc">PhysicalPlanHelper</a>&nbsp;helper)</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="#registerMetrics(org.apache.heron.common.utils.topology.TopologyContextImpl)">registerMetrics</a></span>&#8203;(<a href="../topology/TopologyContextImpl.html" title="class in org.apache.heron.common.utils.topology">TopologyContextImpl</a>&nbsp;topologyContext)</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="#serializeDataTuple(java.lang.String,long)">serializeDataTuple</a></span>&#8203;(java.lang.String&nbsp;streamId,
long&nbsp;latency)</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="#updateContinueWorkCount()">updateContinueWorkCount</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateExecutionCount()">updateExecutionCount</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateOutQueueFullCount()">updateOutQueueFullCount</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateTaskRunCount()">updateTaskRunCount</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;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BoltMetrics</h4>
<pre>public&nbsp;BoltMetrics()</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="registerMetrics(org.apache.heron.common.utils.topology.TopologyContextImpl)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerMetrics</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;registerMetrics&#8203;(<a href="../topology/TopologyContextImpl.html" title="class in org.apache.heron.common.utils.topology">TopologyContextImpl</a>&nbsp;topologyContext)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IBoltMetrics.html#registerMetrics(org.apache.heron.common.utils.topology.TopologyContextImpl)">registerMetrics</a></code>&nbsp;in interface&nbsp;<code><a href="IBoltMetrics.html" title="interface in org.apache.heron.common.utils.metrics">IBoltMetrics</a></code></dd>
</dl>
</li>
</ul>
<a id="initMultiCountMetrics(org.apache.heron.common.utils.misc.PhysicalPlanHelper)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initMultiCountMetrics</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;initMultiCountMetrics&#8203;(<a href="../misc/PhysicalPlanHelper.html" title="class in org.apache.heron.common.utils.misc">PhysicalPlanHelper</a>&nbsp;helper)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IBoltMetrics.html#initMultiCountMetrics(org.apache.heron.common.utils.misc.PhysicalPlanHelper)">initMultiCountMetrics</a></code>&nbsp;in interface&nbsp;<code><a href="IBoltMetrics.html" title="interface in org.apache.heron.common.utils.metrics">IBoltMetrics</a></code></dd>
</dl>
</li>
</ul>
<a id="ackedTuple(java.lang.String,java.lang.String,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ackedTuple</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;ackedTuple&#8203;(java.lang.String&nbsp;streamId,
java.lang.String&nbsp;sourceComponent,
long&nbsp;latency)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IBoltMetrics.html#ackedTuple(java.lang.String,java.lang.String,long)">ackedTuple</a></code>&nbsp;in interface&nbsp;<code><a href="IBoltMetrics.html" title="interface in org.apache.heron.common.utils.metrics">IBoltMetrics</a></code></dd>
</dl>
</li>
</ul>
<a id="failedTuple(java.lang.String,java.lang.String,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>failedTuple</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;failedTuple&#8203;(java.lang.String&nbsp;streamId,
java.lang.String&nbsp;sourceComponent,
long&nbsp;latency)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IBoltMetrics.html#failedTuple(java.lang.String,java.lang.String,long)">failedTuple</a></code>&nbsp;in interface&nbsp;<code><a href="IBoltMetrics.html" title="interface in org.apache.heron.common.utils.metrics">IBoltMetrics</a></code></dd>
</dl>
</li>
</ul>
<a id="executeTuple(java.lang.String,java.lang.String,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeTuple</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;executeTuple&#8203;(java.lang.String&nbsp;streamId,
java.lang.String&nbsp;sourceComponent,
long&nbsp;latency)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IBoltMetrics.html#executeTuple(java.lang.String,java.lang.String,long)">executeTuple</a></code>&nbsp;in interface&nbsp;<code><a href="IBoltMetrics.html" title="interface in org.apache.heron.common.utils.metrics">IBoltMetrics</a></code></dd>
</dl>
</li>
</ul>
<a id="emittedTuple(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emittedTuple</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;emittedTuple&#8203;(java.lang.String&nbsp;streamId)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ComponentMetrics.html#emittedTuple(java.lang.String)">emittedTuple</a></code>&nbsp;in interface&nbsp;<code><a href="ComponentMetrics.html" title="interface in org.apache.heron.common.utils.metrics">ComponentMetrics</a></code></dd>
</dl>
</li>
</ul>
<a id="addTupleToQueue(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTupleToQueue</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addTupleToQueue&#8203;(int&nbsp;size)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ComponentMetrics.html#addTupleToQueue(int)">addTupleToQueue</a></code>&nbsp;in interface&nbsp;<code><a href="ComponentMetrics.html" title="interface in org.apache.heron.common.utils.metrics">ComponentMetrics</a></code></dd>
</dl>
</li>
</ul>
<a id="updateOutQueueFullCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateOutQueueFullCount</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;updateOutQueueFullCount()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IBoltMetrics.html#updateOutQueueFullCount()">updateOutQueueFullCount</a></code>&nbsp;in interface&nbsp;<code><a href="IBoltMetrics.html" title="interface in org.apache.heron.common.utils.metrics">IBoltMetrics</a></code></dd>
</dl>
</li>
</ul>
<a id="deserializeDataTuple(java.lang.String,java.lang.String,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeDataTuple</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;deserializeDataTuple&#8203;(java.lang.String&nbsp;streamId,
java.lang.String&nbsp;sourceComponent,
long&nbsp;latency)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IBoltMetrics.html#deserializeDataTuple(java.lang.String,java.lang.String,long)">deserializeDataTuple</a></code>&nbsp;in interface&nbsp;<code><a href="IBoltMetrics.html" title="interface in org.apache.heron.common.utils.metrics">IBoltMetrics</a></code></dd>
</dl>
</li>
</ul>
<a id="serializeDataTuple(java.lang.String,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializeDataTuple</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;serializeDataTuple&#8203;(java.lang.String&nbsp;streamId,
long&nbsp;latency)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ComponentMetrics.html#serializeDataTuple(java.lang.String,long)">serializeDataTuple</a></code>&nbsp;in interface&nbsp;<code><a href="ComponentMetrics.html" title="interface in org.apache.heron.common.utils.metrics">ComponentMetrics</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IBoltMetrics.html#serializeDataTuple(java.lang.String,long)">serializeDataTuple</a></code>&nbsp;in interface&nbsp;<code><a href="IBoltMetrics.html" title="interface in org.apache.heron.common.utils.metrics">IBoltMetrics</a></code></dd>
</dl>
</li>
</ul>
<a id="updateTaskRunCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateTaskRunCount</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;updateTaskRunCount()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IBoltMetrics.html#updateTaskRunCount()">updateTaskRunCount</a></code>&nbsp;in interface&nbsp;<code><a href="IBoltMetrics.html" title="interface in org.apache.heron.common.utils.metrics">IBoltMetrics</a></code></dd>
</dl>
</li>
</ul>
<a id="updateExecutionCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateExecutionCount</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;updateExecutionCount()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IBoltMetrics.html#updateExecutionCount()">updateExecutionCount</a></code>&nbsp;in interface&nbsp;<code><a href="IBoltMetrics.html" title="interface in org.apache.heron.common.utils.metrics">IBoltMetrics</a></code></dd>
</dl>
</li>
</ul>
<a id="updateContinueWorkCount()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>updateContinueWorkCount</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;updateContinueWorkCount()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="IBoltMetrics.html#updateContinueWorkCount()">updateContinueWorkCount</a></code>&nbsp;in interface&nbsp;<code><a href="IBoltMetrics.html" title="interface in org.apache.heron.common.utils.metrics">IBoltMetrics</a></code></dd>
</dl>
</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>