site/javadoc/r1.2.0/org/apache/edgent/oplet/plumbing/PressureReliever.html - incubator-retired-edgent-website - Git at Google

 <!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_112) on Mon Dec 18 11:25:19 EST 2017 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>PressureReliever (Apache Edgent (incubating) v1.2.0 API)</title>
 <meta name="date" content="2017-12-18">
 <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="PressureReliever (Apache Edgent (incubating) v1.2.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":10,"i1":10,"i2":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/PressureReliever.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/edgent/oplet/plumbing/Isolate.html" title="class in org.apache.edgent.oplet.plumbing"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/apache/edgent/oplet/plumbing/UnorderedIsolate.html" title="class in org.apache.edgent.oplet.plumbing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/edgent/oplet/plumbing/PressureReliever.html" target="_top">Frames</a></li>
 <li><a href="PressureReliever.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&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 name="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">org.apache.edgent.oplet.plumbing</div>
 <h2 title="Class PressureReliever" class="title">Class PressureReliever&lt;T,K&gt;</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="http://docs.oracle.com/javase/8/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/edgent/oplet/core/AbstractOplet.html" title="class in org.apache.edgent.oplet.core">org.apache.edgent.oplet.core.AbstractOplet</a>&lt;I,O&gt;</li>
 <li>
 <ul class="inheritance">
 <li><a href="../../../../../org/apache/edgent/oplet/core/Pipe.html" title="class in org.apache.edgent.oplet.core">org.apache.edgent.oplet.core.Pipe</a>&lt;T,T&gt;</li>
 <li>
 <ul class="inheritance">
 <li>org.apache.edgent.oplet.plumbing.PressureReliever&lt;T,K&gt;</li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>T</code> - Tuple type.</dd>
 <dd><code>K</code> - Key type.</dd>
 </dl>
 <dl>
 <dt>All Implemented Interfaces:</dt>
 <dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../../org/apache/edgent/function/Consumer.html" title="interface in org.apache.edgent.function">Consumer</a>&lt;T&gt;, <a href="../../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet">Oplet</a>&lt;T,T&gt;</dd>
 </dl>
 <hr>
 <br>
 <pre>public class <span class="typeNameLabel">PressureReliever&lt;T,K&gt;</span>
 extends <a href="../../../../../org/apache/edgent/oplet/core/Pipe.html" title="class in org.apache.edgent.oplet.core">Pipe</a>&lt;T,T&gt;</pre>
 <div class="block">Relieve pressure on upstream oplets by discarding tuples.
  This oplet ensures that upstream processing is not
  constrained by any delay in downstream processing,
  for example by a sink oplet not being able to connect
  to its external system.
  When downstream processing cannot keep up with the input rate
  this oplet maintains a defined window of the most recent
  tuples and discards any earlier tuples using arrival order.
  <P>
  A window partition is maintained for each key seen
  on the input stream. Any tuple arriving on the input
  stream is inserted into the window. Asynchronously
  tuples are taken from the window using FIFO and
  submitted downstream. The submission of tuples maintains
  order within a partition but not across partitions.
  </P>
  <P>
  Tuples are  <B>discarded and not</B> submitted to the
  output port if the downstream processing cannot keep up
  the incoming tuple rate.
  </P>
  <UL>
  <LI>For a <a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html#PressureReliever-int-org.apache.edgent.function.Function-"><code>count</code></a>
  <code>PressureReliever</code> up to last (most recent) <code>N</code> tuples
  are maintained in a window partition.
  <BR> Asynchronous tuple submission removes the last (oldest) tuple in the partition
  before submitting it downstream.
  <BR> If when an input tuple is processed the window partition contains N tuples, then
  the first (oldest) tuple in the partition is discarded before the input tuple is inserted into the window.
  </UL>
  <P>
  Insertion of the oplet into a stream disconnects the
  upstream processing from the downstream processing,
  so that downstream processing is executed on a different
  thread to the thread that processed the input tuple.
  </P></div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../../serialized-form.html#org.apache.edgent.oplet.plumbing.PressureReliever">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">&nbsp;</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/edgent/oplet/plumbing/PressureReliever.html#PressureReliever-int-org.apache.edgent.function.Function-">PressureReliever</a></span>(int&nbsp;count,
                 <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a>&lt;<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">T</a>,<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">K</a>&gt;&nbsp;keyFunction)</code>
 <div class="block">Pressure reliever that maintains up to <code>count</code> most recent tuples per key.</div>
 </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">&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="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/edgent/oplet/plumbing/PressureReliever.html#accept-T-">accept</a></span>(<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">T</a>&nbsp;tuple)</code>
 <div class="block">Apply the function to <code>value</code>.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html#close--">close</a></span>()</code>&nbsp;</td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html#initialize-org.apache.edgent.oplet.OpletContext-">initialize</a></span>(<a href="../../../../../org/apache/edgent/oplet/OpletContext.html" title="interface in org.apache.edgent.oplet">OpletContext</a>&lt;<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">T</a>,<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">T</a>&gt;&nbsp;context)</code>
 <div class="block">Initialize the oplet.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.oplet.core.Pipe">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.apache.edgent.oplet.core.<a href="../../../../../org/apache/edgent/oplet/core/Pipe.html" title="class in org.apache.edgent.oplet.core">Pipe</a></h3>
 <code><a href="../../../../../org/apache/edgent/oplet/core/Pipe.html#getDestination--">getDestination</a>, <a href="../../../../../org/apache/edgent/oplet/core/Pipe.html#getInputs--">getInputs</a>, <a href="../../../../../org/apache/edgent/oplet/core/Pipe.html#start--">start</a>, <a href="../../../../../org/apache/edgent/oplet/core/Pipe.html#submit-O-">submit</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.oplet.core.AbstractOplet">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.apache.edgent.oplet.core.<a href="../../../../../org/apache/edgent/oplet/core/AbstractOplet.html" title="class in org.apache.edgent.oplet.core">AbstractOplet</a></h3>
 <code><a href="../../../../../org/apache/edgent/oplet/core/AbstractOplet.html#getOpletContext--">getOpletContext</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&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/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/8/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/8/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="PressureReliever-int-org.apache.edgent.function.Function-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>PressureReliever</h4>
 <pre>public&nbsp;PressureReliever(int&nbsp;count,
                         <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a>&lt;<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">T</a>,<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">K</a>&gt;&nbsp;keyFunction)</pre>
 <div class="block">Pressure reliever that maintains up to <code>count</code> most recent tuples per key.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>count</code> - Number of tuples to maintain where downstream processing cannot keep up.</dd>
 <dd><code>keyFunction</code> - Key function for tuples.</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="initialize-org.apache.edgent.oplet.OpletContext-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>initialize</h4>
 <pre>public&nbsp;void&nbsp;initialize(<a href="../../../../../org/apache/edgent/oplet/OpletContext.html" title="interface in org.apache.edgent.oplet">OpletContext</a>&lt;<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">T</a>,<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">T</a>&gt;&nbsp;context)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/edgent/oplet/Oplet.html#initialize-org.apache.edgent.oplet.OpletContext-">Oplet</a></code></span></div>
 <div class="block">Initialize the oplet.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../../../org/apache/edgent/oplet/Oplet.html#initialize-org.apache.edgent.oplet.OpletContext-">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet">Oplet</a>&lt;<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">T</a>,<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">T</a>&gt;</code></dd>
 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 <dd><code><a href="../../../../../org/apache/edgent/oplet/core/Pipe.html#initialize-org.apache.edgent.oplet.OpletContext-">initialize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/edgent/oplet/core/Pipe.html" title="class in org.apache.edgent.oplet.core">Pipe</a>&lt;<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">T</a>,<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">T</a>&gt;</code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>context</code> - the OpletContext</dd>
 </dl>
 </li>
 </ul>
 <a name="accept-java.lang.Object-">
 <!--   -->
 </a><a name="accept-T-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>accept</h4>
 <pre>public&nbsp;void&nbsp;accept(<a href="../../../../../org/apache/edgent/oplet/plumbing/PressureReliever.html" title="type parameter in PressureReliever">T</a>&nbsp;tuple)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/edgent/function/Consumer.html#accept-T-">Consumer</a></code></span></div>
 <div class="block">Apply the function to <code>value</code>.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>tuple</code> - Value function is applied to.</dd>
 </dl>
 </li>
 </ul>
 <a name="close--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>close</h4>
 <pre>public&nbsp;void&nbsp;close()
            throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
 <dl>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</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/PressureReliever.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/edgent/oplet/plumbing/Isolate.html" title="class in org.apache.edgent.oplet.plumbing"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/apache/edgent/oplet/plumbing/UnorderedIsolate.html" title="class in org.apache.edgent.oplet.plumbing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/edgent/oplet/plumbing/PressureReliever.html" target="_top">Frames</a></li>
 <li><a href="PressureReliever.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../../allclasses-noframe.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>
 </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 name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 <p class="legalCopy"><small>Copyright &#169; 2016&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </body>
 </html>