blob: 08701c586ad110100efd5d3acf4b8c8aa6174839 [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>PackingUtils (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="PackingUtils (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.packing.utils</a></div>
<h2 title="Class PackingUtils" class="title">Class PackingUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.heron.packing.utils.PackingUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public final class <span class="typeNameLabel">PackingUtils</span>
extends java.lang.Object</pre>
<div class="block">Shared utilities for packing algorithms</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PackingUtils.ScalingDirection.html" title="enum in org.apache.heron.packing.utils">PackingUtils.ScalingDirection</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== 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>static double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_CONTAINER_CPU_PADDING">DEFAULT_CONTAINER_CPU_PADDING</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_CONTAINER_DISK_PADDING">DEFAULT_CONTAINER_DISK_PADDING</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_CONTAINER_PADDING_PERCENTAGE">DEFAULT_CONTAINER_PADDING_PERCENTAGE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_CONTAINER_RAM_PADDING">DEFAULT_CONTAINER_RAM_PADDING</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_MAX_NUM_INSTANCES_PER_CONTAINER">DEFAULT_MAX_NUM_INSTANCES_PER_CONTAINER</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static <a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeTotalResourceChange(org.apache.heron.api.generated.TopologyAPI.Topology,java.util.Map,org.apache.heron.spi.packing.Resource,org.apache.heron.packing.utils.PackingUtils.ScalingDirection)">computeTotalResourceChange</a></span>&#8203;(<a href="../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a>&nbsp;topology,
java.util.Map&lt;java.lang.String,&#8203;java.lang.Integer&gt;&nbsp;componentChanges,
<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;defaultInstanceResources,
<a href="PackingUtils.ScalingDirection.html" title="enum in org.apache.heron.packing.utils">PackingUtils.ScalingDirection</a>&nbsp;scalingDirection)</code></th>
<td class="colLast">
<div class="block">Identifies the resources reclaimed by the components that will be scaled down</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#finalizePadding(org.apache.heron.spi.packing.Resource,org.apache.heron.spi.packing.Resource,int)">finalizePadding</a></span>&#8203;(<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;containerResource,
<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;padding,
int&nbsp;paddingPercentage)</code></th>
<td class="colLast">
<div class="block">Finalize padding by taking Math.max(containerResource * paddingPercent, paddingValue)</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static java.util.Map&lt;java.lang.String,&#8203;<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentResourceMap(java.util.Set,java.util.Map,java.util.Map,java.util.Map,org.apache.heron.spi.packing.Resource)">getComponentResourceMap</a></span>&#8203;(java.util.Set&lt;java.lang.String&gt;&nbsp;components,
java.util.Map&lt;java.lang.String,&#8203;<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&gt;&nbsp;componentRamMap,
java.util.Map&lt;java.lang.String,&#8203;java.lang.Double&gt;&nbsp;componentCpuMap,
java.util.Map&lt;java.lang.String,&#8203;<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&gt;&nbsp;componentDiskMap,
<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;defaultInstanceResource)</code></th>
<td class="colLast">
<div class="block">Compose the component resource map by reading from user configs or default</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.util.Map&lt;java.lang.String,&#8203;java.lang.Integer&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentsToScale(java.util.Map,org.apache.heron.packing.utils.PackingUtils.ScalingDirection)">getComponentsToScale</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Integer&gt;&nbsp;componentChanges,
<a href="PackingUtils.ScalingDirection.html" title="enum in org.apache.heron.packing.utils">PackingUtils.ScalingDirection</a>&nbsp;scalingDirection)</code></th>
<td class="colLast">
<div class="block">Identifies which components need to be scaled given specific scaling direction</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#increaseBy(double,int)">increaseBy</a></span>&#8203;(double&nbsp;value,
int&nbsp;paddingPercentage)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#increaseBy(long,int)">increaseBy</a></span>&#8203;(long&nbsp;value,
int&nbsp;paddingPercentage)</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">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="DEFAULT_CONTAINER_PADDING_PERCENTAGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_CONTAINER_PADDING_PERCENTAGE</h4>
<pre>public static final&nbsp;int DEFAULT_CONTAINER_PADDING_PERCENTAGE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.heron.packing.utils.PackingUtils.DEFAULT_CONTAINER_PADDING_PERCENTAGE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_CONTAINER_RAM_PADDING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_CONTAINER_RAM_PADDING</h4>
<pre>public static final&nbsp;<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a> DEFAULT_CONTAINER_RAM_PADDING</pre>
</li>
</ul>
<a id="DEFAULT_CONTAINER_DISK_PADDING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_CONTAINER_DISK_PADDING</h4>
<pre>public static final&nbsp;<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a> DEFAULT_CONTAINER_DISK_PADDING</pre>
</li>
</ul>
<a id="DEFAULT_CONTAINER_CPU_PADDING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_CONTAINER_CPU_PADDING</h4>
<pre>public static final&nbsp;double DEFAULT_CONTAINER_CPU_PADDING</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.heron.packing.utils.PackingUtils.DEFAULT_CONTAINER_CPU_PADDING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="DEFAULT_MAX_NUM_INSTANCES_PER_CONTAINER">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_MAX_NUM_INSTANCES_PER_CONTAINER</h4>
<pre>public static final&nbsp;int DEFAULT_MAX_NUM_INSTANCES_PER_CONTAINER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.heron.packing.utils.PackingUtils.DEFAULT_MAX_NUM_INSTANCES_PER_CONTAINER">Constant Field Values</a></dd>
</dl>
</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="getComponentResourceMap(java.util.Set,java.util.Map,java.util.Map,java.util.Map,org.apache.heron.spi.packing.Resource)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponentResourceMap</h4>
<pre class="methodSignature">public static&nbsp;java.util.Map&lt;java.lang.String,&#8203;<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&gt;&nbsp;getComponentResourceMap&#8203;(java.util.Set&lt;java.lang.String&gt;&nbsp;components,
java.util.Map&lt;java.lang.String,&#8203;<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&gt;&nbsp;componentRamMap,
java.util.Map&lt;java.lang.String,&#8203;java.lang.Double&gt;&nbsp;componentCpuMap,
java.util.Map&lt;java.lang.String,&#8203;<a href="../../common/basics/ByteAmount.html" title="class in org.apache.heron.common.basics">ByteAmount</a>&gt;&nbsp;componentDiskMap,
<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;defaultInstanceResource)</pre>
<div class="block">Compose the component resource map by reading from user configs or default</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>components</code> - component names</dd>
<dd><code>componentRamMap</code> - user configured component ram map</dd>
<dd><code>componentCpuMap</code> - user configured component cpu map</dd>
<dd><code>componentDiskMap</code> - user configured component disk map</dd>
<dd><code>defaultInstanceResource</code> - default instance resources</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>component resource map</dd>
</dl>
</li>
</ul>
<a id="increaseBy(long,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>increaseBy</h4>
<pre class="methodSignature">public static&nbsp;long&nbsp;increaseBy&#8203;(long&nbsp;value,
int&nbsp;paddingPercentage)</pre>
</li>
</ul>
<a id="increaseBy(double,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>increaseBy</h4>
<pre class="methodSignature">public static&nbsp;double&nbsp;increaseBy&#8203;(double&nbsp;value,
int&nbsp;paddingPercentage)</pre>
</li>
</ul>
<a id="finalizePadding(org.apache.heron.spi.packing.Resource,org.apache.heron.spi.packing.Resource,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>finalizePadding</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;finalizePadding&#8203;(<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;containerResource,
<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;padding,
int&nbsp;paddingPercentage)</pre>
<div class="block">Finalize padding by taking Math.max(containerResource * paddingPercent, paddingValue)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>containerResource</code> - max container resource</dd>
<dd><code>padding</code> - padding value</dd>
<dd><code>paddingPercentage</code> - padding percent</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>finalized padding amount</dd>
</dl>
</li>
</ul>
<a id="getComponentsToScale(java.util.Map,org.apache.heron.packing.utils.PackingUtils.ScalingDirection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComponentsToScale</h4>
<pre class="methodSignature">public static&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.Integer&gt;&nbsp;getComponentsToScale&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Integer&gt;&nbsp;componentChanges,
<a href="PackingUtils.ScalingDirection.html" title="enum in org.apache.heron.packing.utils">PackingUtils.ScalingDirection</a>&nbsp;scalingDirection)</pre>
<div class="block">Identifies which components need to be scaled given specific scaling direction</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map &lt; component name, scale factor &gt;</dd>
</dl>
</li>
</ul>
<a id="computeTotalResourceChange(org.apache.heron.api.generated.TopologyAPI.Topology,java.util.Map,org.apache.heron.spi.packing.Resource,org.apache.heron.packing.utils.PackingUtils.ScalingDirection)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>computeTotalResourceChange</h4>
<pre class="methodSignature">public static&nbsp;<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;computeTotalResourceChange&#8203;(<a href="../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a>&nbsp;topology,
java.util.Map&lt;java.lang.String,&#8203;java.lang.Integer&gt;&nbsp;componentChanges,
<a href="../../spi/packing/Resource.html" title="class in org.apache.heron.spi.packing">Resource</a>&nbsp;defaultInstanceResources,
<a href="PackingUtils.ScalingDirection.html" title="enum in org.apache.heron.packing.utils">PackingUtils.ScalingDirection</a>&nbsp;scalingDirection)</pre>
<div class="block">Identifies the resources reclaimed by the components that will be scaled down</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Total resources reclaimed</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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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>