Google Git
Sign in
apache / incubator-retired-edgent-website / 1d74f4c030b7ba91ee3052633b8aafac15d6919c / . / site / javadoc / latest / org / apache / edgent / topology / tester / Tester.html
blob: 7e98d912c5512ba0b6e635d47575e2d803fb4858 [file] [log] [blame]
<!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>Tester (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="Tester (Apache Edgent (incubating) v1.2.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Tester.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/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/edgent/topology/tester/Tester.html" target="_top">Frames</a></li>
<li><a href="Tester.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>Constr&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>Constr&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.topology.tester</div>
<h2 title="Interface Tester" class="title">Interface Tester</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/edgent/topology/spi/tester/AbstractTester.html" title="class in org.apache.edgent.topology.spi.tester">AbstractTester</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Tester</span>
extends <a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></pre>
<div class="block">A <code>Tester</code> adds the ability to test a topology in a test framework such
as JUnit.
The main feature is the ability to capture tuples from a <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology"><code>TStream</code></a> in
order to perform some form of verification on them. There are two mechanisms
to perform verifications:
<UL>
<LI>did the stream produce the correct number of tuples.</LI>
<LI>did the stream produce the correct tuples.</LI>
</UL>
Currently, only streams that are instances of
<code>TStream&lt;String&gt;</code> can have conditions or handlers attached.
<P>
A <code>Tester</code> modifies its <a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology"><code>Topology</code></a> to achieve the above purpose.
</P></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/topology/tester/Tester.html#and-org.apache.edgent.topology.tester.Condition...-">and</a></span>(<a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;?&gt;...&nbsp;conditions)</code>
<div class="block">Return a condition that is valid only if all of <code>conditions</code> are valid.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/topology/tester/Tester.html#atLeastTupleCount-org.apache.edgent.topology.TStream-long-">atLeastTupleCount</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;?&gt;&nbsp;stream,
long&nbsp;expectedCount)</code>
<div class="block">Return a condition that evaluates if <code>stream</code> has submitted at
least <code>expectedCount</code> number of tuples.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/topology/tester/Tester.html#complete-org.apache.edgent.execution.Submitter-com.google.gson.JsonObject-org.apache.edgent.topology.tester.Condition-long-java.util.concurrent.TimeUnit-">complete</a></span>(<a href="../../../../../org/apache/edgent/execution/Submitter.html" title="interface in org.apache.edgent.execution">Submitter</a>&lt;<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,? extends <a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>&gt;&nbsp;submitter,
com.google.gson.JsonObject&nbsp;config,
<a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;?&gt;&nbsp;endCondition,
long&nbsp;timeout,
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</code>
<div class="block">Submit the topology for this tester and wait for it to complete, or reach
an end condition.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/topology/tester/Tester.html#contentsUnordered-org.apache.edgent.topology.TStream-T...-">contentsUnordered</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;&nbsp;stream,
T...&nbsp;values)</code>
<div class="block">Return a condition that evaluates if <code>stream</code> has submitted
tuples matching <code>values</code> in any order.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/topology/tester/Tester.html#getJob--">getJob</a></span>()</code>
<div class="block">Get the <code>Job</code> reference for the topology submitted by <code>complete()</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/topology/tester/Tester.html#streamContents-org.apache.edgent.topology.TStream-T...-">streamContents</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;&nbsp;stream,
T...&nbsp;values)</code>
<div class="block">Return a condition that evaluates if <code>stream</code> has submitted
tuples matching <code>values</code> in the same order.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/topology/tester/Tester.html#tupleCount-org.apache.edgent.topology.TStream-long-">tupleCount</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;?&gt;&nbsp;stream,
long&nbsp;expectedCount)</code>
<div class="block">Return a condition that evaluates if <code>stream</code> has submitted exactly
<code>expectedCount</code> number of tuples.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.topology.TopologyElement">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.edgent.topology.<a href="../../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></h3>
<code><a href="../../../../../org/apache/edgent/topology/TopologyElement.html#topology--">topology</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="tupleCount-org.apache.edgent.topology.TStream-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tupleCount</h4>
<pre><a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;tupleCount(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;?&gt;&nbsp;stream,
long&nbsp;expectedCount)</pre>
<div class="block">Return a condition that evaluates if <code>stream</code> has submitted exactly
<code>expectedCount</code> number of tuples. The function may be evaluated
after the <a href="../../../../../org/apache/edgent/execution/Submitter.html#submit-E-com.google.gson.JsonObject-"><code>submit</code></a>
call has returned. <BR>
The <a href="../../../../../org/apache/edgent/topology/tester/Condition.html#getResult--"><code>result</code></a> of the returned
<code>Condition</code> is the number of tuples seen on <code>stream</code> so far.
<BR>
If the topology is still executing then the returned values from
<a href="../../../../../org/apache/edgent/topology/tester/Condition.html#valid--"><code>Condition.valid()</code></a> and <a href="../../../../../org/apache/edgent/topology/tester/Condition.html#getResult--"><code>Condition.getResult()</code></a> may change as
more tuples are seen on <code>stream</code>. <BR></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - Stream to be tested.</dd>
<dd><code>expectedCount</code> - Number of tuples expected on <code>stream</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the stream has submitted exactly <code>expectedCount</code>
number of tuples, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="atLeastTupleCount-org.apache.edgent.topology.TStream-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>atLeastTupleCount</h4>
<pre><a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;atLeastTupleCount(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;?&gt;&nbsp;stream,
long&nbsp;expectedCount)</pre>
<div class="block">Return a condition that evaluates if <code>stream</code> has submitted at
least <code>expectedCount</code> number of tuples. The function may be
evaluated after the
<a href="../../../../../org/apache/edgent/execution/Submitter.html#submit-E-com.google.gson.JsonObject-"><code>submit</code></a> call has returned. <BR>
The <a href="../../../../../org/apache/edgent/topology/tester/Condition.html#getResult--"><code>result</code></a> of the returned
<code>Condition</code> is the number of tuples seen on <code>stream</code> so far.
<BR>
If the topology is still executing then the returned values from
<a href="../../../../../org/apache/edgent/topology/tester/Condition.html#valid--"><code>Condition.valid()</code></a> and <a href="../../../../../org/apache/edgent/topology/tester/Condition.html#getResult--"><code>Condition.getResult()</code></a> may change as
more tuples are seen on <code>stream</code>. <BR></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - Stream to be tested.</dd>
<dd><code>expectedCount</code> - Number of tuples expected on <code>stream</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Condition that will return true the stream has submitted at least
<code>expectedCount</code> number of tuples, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="streamContents-org.apache.edgent.topology.TStream-java.lang.Object:A-">
<!-- -->
</a><a name="streamContents-org.apache.edgent.topology.TStream-T...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>streamContents</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&gt;&nbsp;streamContents(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;&nbsp;stream,
T...&nbsp;values)</pre>
<div class="block">Return a condition that evaluates if <code>stream</code> has submitted
tuples matching <code>values</code> in the same order. <BR>
The <a href="../../../../../org/apache/edgent/topology/tester/Condition.html#getResult--"><code>result</code></a> of the returned
<code>Condition</code> is the tuples seen on <code>stream</code> so far. <BR>
If the topology is still executing then the returned values from
<a href="../../../../../org/apache/edgent/topology/tester/Condition.html#valid--"><code>Condition.valid()</code></a> and <a href="../../../../../org/apache/edgent/topology/tester/Condition.html#getResult--"><code>Condition.getResult()</code></a> may change as
more tuples are seen on <code>stream</code>. <BR></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Tuple type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - Stream to be tested.</dd>
<dd><code>values</code> - Expected tuples on <code>stream</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Condition that will return true if the stream has submitted at
least tuples matching <code>values</code> in the same order, false
otherwise.</dd>
</dl>
</li>
</ul>
<a name="contentsUnordered-org.apache.edgent.topology.TStream-java.lang.Object:A-">
<!-- -->
</a><a name="contentsUnordered-org.apache.edgent.topology.TStream-T...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contentsUnordered</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&gt;&nbsp;contentsUnordered(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a>&lt;T&gt;&nbsp;stream,
T...&nbsp;values)</pre>
<div class="block">Return a condition that evaluates if <code>stream</code> has submitted
tuples matching <code>values</code> in any order. <BR>
The <a href="../../../../../org/apache/edgent/topology/tester/Condition.html#getResult--"><code>result</code></a> of the returned
<code>Condition</code> is the tuples seen on <code>stream</code> so far. <BR>
If the topology is still executing then the returned values from
<a href="../../../../../org/apache/edgent/topology/tester/Condition.html#valid--"><code>Condition.valid()</code></a> and <a href="../../../../../org/apache/edgent/topology/tester/Condition.html#getResult--"><code>Condition.getResult()</code></a> may change as
more tuples are seen on <code>stream</code>. <BR></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Tuple type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - Stream to be tested.</dd>
<dd><code>values</code> - Expected tuples on <code>stream</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Condition that will return true if the stream has submitted at
least tuples matching <code>values</code> in the any order, false
otherwise.</dd>
</dl>
</li>
</ul>
<a name="and-org.apache.edgent.topology.tester.Condition...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>and</h4>
<pre><a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&gt;&nbsp;and(<a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;?&gt;...&nbsp;conditions)</pre>
<div class="block">Return a condition that is valid only if all of <code>conditions</code> are valid.
The result of the condition is <a href="../../../../../org/apache/edgent/topology/tester/Condition.html#valid--"><code>Condition.valid()</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conditions</code> - Conditions to AND together.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>condition that is valid only if all of <code>conditions</code> are valid.</dd>
</dl>
</li>
</ul>
<a name="complete-org.apache.edgent.execution.Submitter-com.google.gson.JsonObject-org.apache.edgent.topology.tester.Condition-long-java.util.concurrent.TimeUnit-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>complete</h4>
<pre>boolean&nbsp;complete(<a href="../../../../../org/apache/edgent/execution/Submitter.html" title="interface in org.apache.edgent.execution">Submitter</a>&lt;<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,? extends <a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>&gt;&nbsp;submitter,
com.google.gson.JsonObject&nbsp;config,
<a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester">Condition</a>&lt;?&gt;&nbsp;endCondition,
long&nbsp;timeout,
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)
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>
<div class="block">Submit the topology for this tester and wait for it to complete, or reach
an end condition. If the topology does not complete or reach its end
condition before <code>timeout</code> then it is terminated.
<P>
End condition is usually a <a href="../../../../../org/apache/edgent/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester"><code>Condition</code></a> returned from
<a href="../../../../../org/apache/edgent/topology/tester/Tester.html#atLeastTupleCount-org.apache.edgent.topology.TStream-long-"><code>atLeastTupleCount(TStream, long)</code></a> or
<a href="../../../../../org/apache/edgent/topology/tester/Tester.html#tupleCount-org.apache.edgent.topology.TStream-long-"><code>tupleCount(TStream, long)</code></a> so that this method returns once the
stream has submitted a sufficient number of tuples. <BR>
Note that the condition will be only checked periodically up to
<code>timeout</code>, so that if the condition is only valid for a brief
period of time, then its valid state may not be seen, and thus this
method will wait for the timeout period.
</P></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>submitter</code> - the <a href="../../../../../org/apache/edgent/execution/Submitter.html" title="interface in org.apache.edgent.execution"><code>Submitter</code></a></dd>
<dd><code>config</code> - submission configuration.</dd>
<dd><code>endCondition</code> - Condition that will cause this method to return if it is true.</dd>
<dd><code>timeout</code> - Maximum time to wait for the topology to complete or reach its
end condition.</dd>
<dd><code>unit</code> - Unit for <code>timeout</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value of <code>endCondition.valid()</code>.</dd>
<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> - Failure submitting or executing the topology.</dd>
</dl>
</li>
</ul>
<a name="getJob--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getJob</h4>
<pre><a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>&nbsp;getJob()</pre>
<div class="block">Get the <code>Job</code> reference for the topology submitted by <code>complete()</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>Job</code> reference for the topology submitted by <code>complete()</code>.
Null if the <code>complete()</code> has not been called or the <code>Job</code> instance is not yet available.</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/Tester.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/topology/tester/Condition.html" title="interface in org.apache.edgent.topology.tester"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/edgent/topology/tester/Tester.html" target="_top">Frames</a></li>
<li><a href="Tester.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>Constr&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>Constr&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>