Google Git
Sign in
apache / incubator-heron / refs/heads/asf-site / . / content / api / java / org / apache / heron / streamlet / impl / sources / StreamletSource.html
blob: 1b1e59531d1356e3bcd0044618b29f57b41ae11f [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>StreamletSource (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="StreamletSource (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.streamlet.impl.sources</a></div>
<h2 title="Class StreamletSource" class="title">Class StreamletSource</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../api/topology/BaseComponent.html" title="class in org.apache.heron.api.topology">org.apache.heron.api.topology.BaseComponent</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../api/spout/BaseRichSpout.html" title="class in org.apache.heron.api.spout">org.apache.heron.api.spout.BaseRichSpout</a></li>
<li>
<ul class="inheritance">
<li>org.apache.heron.streamlet.impl.sources.StreamletSource</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code><a href="../../../api/spout/IRichSpout.html" title="interface in org.apache.heron.api.spout">IRichSpout</a></code>, <code><a href="../../../api/spout/ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a></code>, <code><a href="../../../api/topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></code>, <code><a href="../../../api/topology/IStatefulComponent.html" title="interface in org.apache.heron.api.topology">IStatefulComponent</a>&lt;java.io.Serializable,&#8203;java.io.Serializable&gt;</code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="ComplexSource.html" title="class in org.apache.heron.streamlet.impl.sources">ComplexSource</a></code>, <code><a href="SupplierSource.html" title="class in org.apache.heron.streamlet.impl.sources">SupplierSource</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">StreamletSource</span>
extends <a href="../../../api/spout/BaseRichSpout.html" title="class in org.apache.heron.api.spout">BaseRichSpout</a>
implements <a href="../../../api/topology/IStatefulComponent.html" title="interface in org.apache.heron.api.topology">IStatefulComponent</a>&lt;java.io.Serializable,&#8203;java.io.Serializable&gt;</pre>
<div class="block">StreamletSource is the base class for all streamlet sources.
The only common stuff amongst all of them is the output streams</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.heron.streamlet.impl.sources.StreamletSource">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../api/spout/SpoutOutputCollector.html" title="class in org.apache.heron.api.spout">SpoutOutputCollector</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collector">collector</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== 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()">StreamletSource</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="#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">declareOutputFields</a></span>&#8203;(<a href="../../../api/topology/OutputFieldsDeclarer.html" title="interface in org.apache.heron.api.topology">OutputFieldsDeclarer</a>&nbsp;outputFieldsDeclarer)</code></th>
<td class="colLast">
<div class="block">The sources implementing streamlet functionality have some properties.</div>
</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="#initState(org.apache.heron.api.state.State)">initState</a></span>&#8203;(<a href="../../../api/state/State.html" title="interface in org.apache.heron.api.state">State</a>&lt;java.io.Serializable,&#8203;java.io.Serializable&gt;&nbsp;state)</code></th>
<td class="colLast">
<div class="block">Initializes the state of the function or operator to that of a previous checkpoint.</div>
</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="#open(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.spout.SpoutOutputCollector)">open</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;map,
<a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a>&nbsp;topologyContext,
<a href="../../../api/spout/SpoutOutputCollector.html" title="class in org.apache.heron.api.spout">SpoutOutputCollector</a>&nbsp;outputCollector)</code></th>
<td class="colLast">
<div class="block">Called when a task for this component is initialized within a worker on the cluster.</div>
</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="#preSave(java.lang.String)">preSave</a></span>&#8203;(java.lang.String&nbsp;checkpointId)</code></th>
<td class="colLast">
<div class="block">This is a hook for the component to perform some actions just before the
framework saves its state.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.api.spout.BaseRichSpout">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.heron.api.spout.<a href="../../../api/spout/BaseRichSpout.html" title="class in org.apache.heron.api.spout">BaseRichSpout</a></h3>
<code><a href="../../../api/spout/BaseRichSpout.html#ack(java.lang.Object)">ack</a>, <a href="../../../api/spout/BaseRichSpout.html#activate()">activate</a>, <a href="../../../api/spout/BaseRichSpout.html#close()">close</a>, <a href="../../../api/spout/BaseRichSpout.html#deactivate()">deactivate</a>, <a href="../../../api/spout/BaseRichSpout.html#fail(java.lang.Object)">fail</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.api.topology.BaseComponent">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.heron.api.topology.<a href="../../../api/topology/BaseComponent.html" title="class in org.apache.heron.api.topology">BaseComponent</a></h3>
<code><a href="../../../api/topology/BaseComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code></li>
</ul>
<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>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.api.topology.IComponent">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.heron.api.topology.<a href="../../../api/topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></h3>
<code><a href="../../../api/topology/IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.api.spout.ISpout">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.heron.api.spout.<a href="../../../api/spout/ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a></h3>
<code><a href="../../../api/spout/ISpout.html#nextTuple()">nextTuple</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="collector">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>collector</h4>
<pre>protected&nbsp;<a href="../../../api/spout/SpoutOutputCollector.html" title="class in org.apache.heron.api.spout">SpoutOutputCollector</a> collector</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= 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>StreamletSource</h4>
<pre>public&nbsp;StreamletSource()</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="initState(org.apache.heron.api.state.State)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initState</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;initState&#8203;(<a href="../../../api/state/State.html" title="interface in org.apache.heron.api.state">State</a>&lt;java.io.Serializable,&#8203;java.io.Serializable&gt;&nbsp;state)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/topology/IStatefulComponent.html#initState(org.apache.heron.api.state.State)">IStatefulComponent</a></code></span></div>
<div class="block">Initializes the state of the function or operator to that of a previous checkpoint.
This method is invoked when a component is executed as part of a recovery run. In case
there was prior state associated with the component, the state will be empty.
Stateful Spouts/Bolts are expected to hold on to the state variable to save their
internal state
<p>
Note that initialState() is called before open() or prepare().</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/topology/IStatefulComponent.html#initState(org.apache.heron.api.state.State)">initState</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/topology/IStatefulComponent.html" title="interface in org.apache.heron.api.topology">IStatefulComponent</a>&lt;java.io.Serializable,&#8203;java.io.Serializable&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - the previously saved state of the component.</dd>
</dl>
</li>
</ul>
<a id="preSave(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preSave</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;preSave&#8203;(java.lang.String&nbsp;checkpointId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/topology/IStatefulComponent.html#preSave(java.lang.String)">IStatefulComponent</a></code></span></div>
<div class="block">This is a hook for the component to perform some actions just before the
framework saves its state.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/topology/IStatefulComponent.html#preSave(java.lang.String)">preSave</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/topology/IStatefulComponent.html" title="interface in org.apache.heron.api.topology">IStatefulComponent</a>&lt;java.io.Serializable,&#8203;java.io.Serializable&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>checkpointId</code> - the ID of the checkpoint</dd>
</dl>
</li>
</ul>
<a id="open(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.spout.SpoutOutputCollector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;open&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;map,
<a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a>&nbsp;topologyContext,
<a href="../../../api/spout/SpoutOutputCollector.html" title="class in org.apache.heron.api.spout">SpoutOutputCollector</a>&nbsp;outputCollector)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/spout/ISpout.html#open(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.spout.SpoutOutputCollector)">ISpout</a></code></span></div>
<div class="block">Called when a task for this component is initialized within a worker on the cluster.
It provides the spout with the environment in which the spout executes.
<p>
<p>This includes the:</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/spout/ISpout.html#open(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.spout.SpoutOutputCollector)">open</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/spout/ISpout.html" title="interface in org.apache.heron.api.spout">ISpout</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>map</code> - The Heron configuration for this spout. This is the configuration provided to the topology merged in with cluster configuration on this machine.</dd>
<dd><code>topologyContext</code> - This object can be used to get information about this task's place within the topology, including the task id and component id of this task, input and output information, etc.</dd>
<dd><code>outputCollector</code> - The collector is used to emit tuples from this spout. Tuples can be emitted at any time, including the open and close methods. The collector is thread-safe and should be saved as an instance variable of this spout object.</dd>
</dl>
</li>
</ul>
<a id="declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>declareOutputFields</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;declareOutputFields&#8203;(<a href="../../../api/topology/OutputFieldsDeclarer.html" title="interface in org.apache.heron.api.topology">OutputFieldsDeclarer</a>&nbsp;outputFieldsDeclarer)</pre>
<div class="block">The sources implementing streamlet functionality have some properties.
1. They all output only one stream
2. All streamlet operators should be able to consume their output
This imply that the output stream should be named same for all of them.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/topology/IComponent.html#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">declareOutputFields</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outputFieldsDeclarer</code> - this is used to declare output stream ids, output fields, and whether or not each output stream is a direct stream</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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>