| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>StatefulIntegrationTestSpout (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="StatefulIntegrationTestSpout (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":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 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.apache.heron.integration_test.core</a></div> |
| <h2 title="Class StatefulIntegrationTestSpout" class="title">Class StatefulIntegrationTestSpout<K extends java.io.Serializable,​V extends java.io.Serializable></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="IntegrationTestSpout.html" title="class in org.apache.heron.integration_test.core">org.apache.heron.integration_test.core.IntegrationTestSpout</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.integration_test.core.StatefulIntegrationTestSpout<K,​V></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><K,​V></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">StatefulIntegrationTestSpout<K extends java.io.Serializable,​V extends java.io.Serializable></span> |
| extends <a href="IntegrationTestSpout.html" title="class in org.apache.heron.integration_test.core">IntegrationTestSpout</a> |
| implements <a href="../../api/topology/IStatefulComponent.html" title="interface in org.apache.heron.api.topology">IStatefulComponent</a><K,​V></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.heron.integration_test.core.StatefulIntegrationTestSpout">Serialized Form</a></dd> |
| </dl> |
| </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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.heron.integration_test.core.IntegrationTestSpout"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.heron.integration_test.core.<a href="IntegrationTestSpout.html" title="class in org.apache.heron.integration_test.core">IntegrationTestSpout</a></h3> |
| <code><a href="IntegrationTestSpout.IntegrationTestSpoutCollector.html" title="class in org.apache.heron.integration_test.core">IntegrationTestSpout.IntegrationTestSpoutCollector</a></code></li> |
| </ul> |
| </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"> </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(org.apache.heron.api.spout.IRichSpout,int,java.lang.String)">StatefulIntegrationTestSpout</a></span>​(<a href="../../api/spout/IRichSpout.html" title="interface in org.apache.heron.api.spout">IRichSpout</a> delegateSpout, |
| int maxExecutions, |
| java.lang.String topologyStartedStateUrl)</code></th> |
| <td class="colLast"> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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="#initState(org.apache.heron.api.state.State)">initState</a></span>​(<a href="../../api/state/State.html" title="interface in org.apache.heron.api.state">State</a><<a href="StatefulIntegrationTestSpout.html" title="type parameter in StatefulIntegrationTestSpout">K</a>,​<a href="StatefulIntegrationTestSpout.html" title="type parameter in StatefulIntegrationTestSpout">V</a>> 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="i1" 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>​(java.lang.String 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.integration_test.core.IntegrationTestSpout"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.heron.integration_test.core.<a href="IntegrationTestSpout.html" title="class in org.apache.heron.integration_test.core">IntegrationTestSpout</a></h3> |
| <code><a href="IntegrationTestSpout.html#ack(java.lang.Object)">ack</a>, <a href="IntegrationTestSpout.html#activate()">activate</a>, <a href="IntegrationTestSpout.html#close()">close</a>, <a href="IntegrationTestSpout.html#deactivate()">deactivate</a>, <a href="IntegrationTestSpout.html#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">declareOutputFields</a>, <a href="IntegrationTestSpout.html#doneAcking()">doneAcking</a>, <a href="IntegrationTestSpout.html#doneEmitting()">doneEmitting</a>, <a href="IntegrationTestSpout.html#emitTerminalIfNeeded()">emitTerminalIfNeeded</a>, <a href="IntegrationTestSpout.html#fail(java.lang.Object)">fail</a>, <a href="IntegrationTestSpout.html#getComponentConfiguration()">getComponentConfiguration</a>, <a href="IntegrationTestSpout.html#getPostEmitSleepTime()">getPostEmitSleepTime</a>, <a href="IntegrationTestSpout.html#getPostEmitSleepTimeUnit()">getPostEmitSleepTimeUnit</a>, <a href="IntegrationTestSpout.html#handleAckedMessage(java.lang.Object,java.util.List)">handleAckedMessage</a>, <a href="IntegrationTestSpout.html#nextTuple()">nextTuple</a>, <a href="IntegrationTestSpout.html#open(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.spout.SpoutOutputCollector)">open</a>, <a href="IntegrationTestSpout.html#resetMaxExecutions(int)">resetMaxExecutions</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 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 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#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">declareOutputFields</a>, <a href="../../api/topology/IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></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="<init>(org.apache.heron.api.spout.IRichSpout,int,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>StatefulIntegrationTestSpout</h4> |
| <pre>public StatefulIntegrationTestSpout​(<a href="../../api/spout/IRichSpout.html" title="interface in org.apache.heron.api.spout">IRichSpout</a> delegateSpout, |
| int maxExecutions, |
| java.lang.String topologyStartedStateUrl)</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 void initState​(<a href="../../api/state/State.html" title="interface in org.apache.heron.api.state">State</a><<a href="StatefulIntegrationTestSpout.html" title="type parameter in StatefulIntegrationTestSpout">K</a>,​<a href="StatefulIntegrationTestSpout.html" title="type parameter in StatefulIntegrationTestSpout">V</a>> state)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="../../api/topology/IStatefulComponent.html" title="interface in org.apache.heron.api.topology">IStatefulComponent</a><<a href="StatefulIntegrationTestSpout.html" title="type parameter in StatefulIntegrationTestSpout">K</a> extends java.io.Serializable,​<a href="StatefulIntegrationTestSpout.html" title="type parameter in StatefulIntegrationTestSpout">V</a> extends java.io.Serializable></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="blockListLast"> |
| <li class="blockList"> |
| <h4>preSave</h4> |
| <pre class="methodSignature">public void preSave​(java.lang.String checkpointId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="../../api/topology/IStatefulComponent.html" title="interface in org.apache.heron.api.topology">IStatefulComponent</a><<a href="StatefulIntegrationTestSpout.html" title="type parameter in StatefulIntegrationTestSpout">K</a> extends java.io.Serializable,​<a href="StatefulIntegrationTestSpout.html" title="type parameter in StatefulIntegrationTestSpout">V</a> extends java.io.Serializable></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>checkpointId</code> - the ID of the checkpoint</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 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
