geb/manual/snapshot/api/geb/waiting/WaitingSupport.html (233 lines of code) (raw):
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- * PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- * i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->
<html>
<head>
<!-- Generated by groovydoc -->
<title>WaitingSupport (Groovy API Documentation for Geb 8.0-SNAPSHOT)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link href="../../groovy.ico" type="image/x-icon" rel="shortcut icon">
<link href="../../groovy.ico" type="image/x-icon" rel="icon">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WaitingSupport (Groovy API Documentation for Geb 8.0-SNAPSHOT)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="../../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">
<div>
<ul class="navList">
<li><a href="../../index.html?geb/waiting/WaitingSupport" target="_top">Frames</a></li>
<li><a href="WaitingSupport.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
Nested Field <li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li> | Detail: </li>
Field <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">Package: <strong>geb.waiting</strong></div>
<h2 title="[Groovy] Interface WaitingSupport" class="title">[Groovy] Interface WaitingSupport</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<!-- todo: direct known subclasses -->
<hr>
<pre>interface WaitingSupport</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== NESTED CLASS SUMMARY =========== -->
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- =========== PROPERTY SUMMARY =========== -->
<!-- =========== ELEMENT SUMMARY =========== -->
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary"><!-- --></a>
<h3>Methods Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Type Params</th>
<th class="colLast" scope="col">Return Type</th>
<th class="colLast" scope="col">Name and description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><T></code></td>
<td class="colLast"><code>abstract T</code></td>
<td class="colLast"><code><strong><a href="#waitFor(java.lang.String, Closure)">waitFor</a></strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/lang/String.html' title='String'>String</a> waitPreset, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</code><br>Uses the <a href='../../geb/Configuration.html#getWaitPreset(java.lang.String)' title='wait preset'>wait preset</a> from the <CODE>configuration</CODE>
with the given name to to wait for <CODE>block</CODE> to return a true value according to the Groovy Truth.</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><T></code></td>
<td class="colLast"><code>abstract T</code></td>
<td class="colLast"><code><strong><a href="#waitFor(java.util.Map, java.lang.String, Closure)">waitFor</a></strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/util/Map.html' title='Map'>Map</a> params, <a href='http://docs.oracle.com/javase/8/docs/api/java/lang/String.html' title='String'>String</a> waitPreset, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><T></code></td>
<td class="colLast"><code>abstract T</code></td>
<td class="colLast"><code><strong><a href="#waitFor(Closure)">waitFor</a></strong>(<a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</code><br>Uses the <a href='../../geb/Configuration.html#getDefaultWait()' title='default wait'>default wait</a> from the <CODE>configuration</CODE> to
wait for <CODE>block</CODE> to return a true value according to the Groovy Truth.</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><T></code></td>
<td class="colLast"><code>abstract T</code></td>
<td class="colLast"><code><strong><a href="#waitFor(java.util.Map, Closure)">waitFor</a></strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/util/Map.html' title='Map'>Map</a> params, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><T></code></td>
<td class="colLast"><code>abstract T</code></td>
<td class="colLast"><code><strong><a href="#waitFor(java.lang.Number, Closure)">waitFor</a></strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html' title='Number'>Number</a> timeout, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</code><br>Invokes <CODE>block</CODE> every <a href='../../geb/Configuration.html#getDefaultWaitRetryInterval()' title='Configuration.getDefaultWaitRetryInterval'>Configuration.getDefaultWaitRetryInterval</a> seconds, until it returns
a true value according to the Groovy Truth, waiting at most <CODE>timeout</CODE> seconds.</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><T></code></td>
<td class="colLast"><code>abstract T</code></td>
<td class="colLast"><code><strong><a href="#waitFor(java.util.Map, java.lang.Number, Closure)">waitFor</a></strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/util/Map.html' title='Map'>Map</a> params, <a href='http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html' title='Number'>Number</a> timeout, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</code><br></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><T></code></td>
<td class="colLast"><code>abstract T</code></td>
<td class="colLast"><code><strong><a href="#waitFor(java.lang.Number, java.lang.Number, Closure)">waitFor</a></strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html' title='Number'>Number</a> timeout, <a href='http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html' title='Number'>Number</a> interval, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</code><br>Invokes <CODE>block</CODE> every <CODE>interval</CODE> seconds, until it returns
a true value according to the Groovy Truth, waiting at most <CODE>timeout</CODE> seconds.</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><T></code></td>
<td class="colLast"><code>abstract T</code></td>
<td class="colLast"><code><strong><a href="#waitFor(java.util.Map, java.lang.Number, java.lang.Number, Closure)">waitFor</a></strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/util/Map.html' title='Map'>Map</a> params, <a href='http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html' title='Number'>Number</a> timeout, <a href='http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html' title='Number'>Number</a> interval, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</code><br></td>
</tr>
</table>
</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="waitFor(java.lang.String, Closure)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><T> abstract T <strong>waitFor</strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/lang/String.html' title='String'>String</a> waitPreset, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</h4>
<p> Uses the <a href='../../geb/Configuration.html#getWaitPreset(java.lang.String)' title='wait preset'>wait preset</a> from the <CODE>configuration</CODE>
with the given name to to wait for <CODE>block</CODE> to return a true value according to the Groovy Truth.<DL><DT><B>throws:</B></DT><DD><a href='../../geb/waiting/WaitTimeoutException.html' title='WaitTimeoutException'>WaitTimeoutException</a> if the block does not produce a true-ish value in time</DD></DL> <DL><DT><B>Parameters:</B></DT><DD><code>waitPreset</code> - the name of the wait preset in <CODE>configuration</CODE> to use</DD><DD><code>block</code> - what is to be waited on to return a true-ish value</DD></DL><DL><DT><B>Returns:</B></DT><DD>the true-ish return value from <CODE>block</CODE></DD></DL><DL><DT><B>See Also:</B></DT><DD><a href='../../geb/Configuration.html#getWaitPreset(java.lang.String)' title='Configuration.getWaitPreset'>Configuration.getWaitPreset</a></DD></DL></p>
</li>
</ul>
<a name="waitFor(java.util.Map, java.lang.String, Closure)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><T> abstract T <strong>waitFor</strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/util/Map.html' title='Map'>Map</a> params, <a href='http://docs.oracle.com/javase/8/docs/api/java/lang/String.html' title='String'>String</a> waitPreset, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</h4>
<p></p>
</li>
</ul>
<a name="waitFor(Closure)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><T> abstract T <strong>waitFor</strong>(<a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</h4>
<p> Uses the <a href='../../geb/Configuration.html#getDefaultWait()' title='default wait'>default wait</a> from the <CODE>configuration</CODE> to
wait for <CODE>block</CODE> to return a true value according to the Groovy Truth.<DL><DT><B>throws:</B></DT><DD><a href='../../geb/waiting/WaitTimeoutException.html' title='WaitTimeoutException'>WaitTimeoutException</a> if the block does not produce a true-ish value in time</DD></DL> <DL><DT><B>Parameters:</B></DT><DD><code>block</code> - what is to be waited on to return a true-ish value</DD></DL><DL><DT><B>Returns:</B></DT><DD>the true-ish return value from <CODE>block</CODE></DD></DL><DL><DT><B>See Also:</B></DT><DD><a href='../../geb/Configuration.html#getDefaultWait()' title='Configuration.getDefaultWait'>Configuration.getDefaultWait</a></DD></DL></p>
</li>
</ul>
<a name="waitFor(java.util.Map, Closure)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><T> abstract T <strong>waitFor</strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/util/Map.html' title='Map'>Map</a> params, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</h4>
<p></p>
</li>
</ul>
<a name="waitFor(java.lang.Number, Closure)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><T> abstract T <strong>waitFor</strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html' title='Number'>Number</a> timeout, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</h4>
<p> Invokes <CODE>block</CODE> every <a href='../../geb/Configuration.html#getDefaultWaitRetryInterval()' title='Configuration.getDefaultWaitRetryInterval'>Configuration.getDefaultWaitRetryInterval</a> seconds, until it returns
a true value according to the Groovy Truth, waiting at most <CODE>timeout</CODE> seconds.<DL><DT><B>throws:</B></DT><DD><a href='../../geb/waiting/WaitTimeoutException.html' title='WaitTimeoutException'>WaitTimeoutException</a> if the block does not produce a true-ish value in time</DD></DL> <DL><DT><B>Parameters:</B></DT><DD><code>timeout</code> - the number of seconds to wait for block to return (roughly)</DD><DD><code>block</code> - what is to be waited on to return a true-ish value</DD></DL><DL><DT><B>Returns:</B></DT><DD>the true-ish return value from <CODE>block</CODE></DD></DL></p>
</li>
</ul>
<a name="waitFor(java.util.Map, java.lang.Number, Closure)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><T> abstract T <strong>waitFor</strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/util/Map.html' title='Map'>Map</a> params, <a href='http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html' title='Number'>Number</a> timeout, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</h4>
<p></p>
</li>
</ul>
<a name="waitFor(java.lang.Number, java.lang.Number, Closure)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><T> abstract T <strong>waitFor</strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html' title='Number'>Number</a> timeout, <a href='http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html' title='Number'>Number</a> interval, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</h4>
<p> Invokes <CODE>block</CODE> every <CODE>interval</CODE> seconds, until it returns
a true value according to the Groovy Truth, waiting at most <CODE>timeout</CODE> seconds.<DL><DT><B>throws:</B></DT><DD><a href='../../geb/waiting/WaitTimeoutException.html' title='WaitTimeoutException'>WaitTimeoutException</a> if the block does not produce a true-ish value in time</DD></DL> <DL><DT><B>Parameters:</B></DT><DD><code>interval</code> - the number of seconds to wait between invoking <CODE>block</CODE></DD><DD><code>timeout</code> - the number of seconds to wait for block to return (roughly)</DD><DD><code>block</code> - what is to be waited on to return a true-ish value</DD></DL><DL><DT><B>Returns:</B></DT><DD>the true-ish return value from <CODE>block</CODE></DD></DL></p>
</li>
</ul>
<a name="waitFor(java.util.Map, java.lang.Number, java.lang.Number, Closure)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><T> abstract T <strong>waitFor</strong>(<a href='http://docs.oracle.com/javase/8/docs/api/java/util/Map.html' title='Map'>Map</a> params, <a href='http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html' title='Number'>Number</a> timeout, <a href='http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html' title='Number'>Number</a> interval, <a href='http://docs.groovy-lang.org/docs/groovy-4.0.26/html/api/groovy/lang/Closure.html' title='Closure'>Closure</a><T> block)</h4>
<p></p>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="../../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">
<div>
<ul class="navList">
<li><a href="../../index.html?geb/waiting/WaitingSupport" target="_top">Frames</a></li>
<li><a href="WaitingSupport.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
Nested Field <li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li> | Detail: </li>
Field <li><a href="#method_detail">Method</a></li>
</ul>
</div>
<p><p style='text-align: center'>Groovy API Documentation for Geb 8.0-SNAPSHOT - Licensed under the Apache License, Version 2.0 - <a href='http://www.gebish.org'>http://www.gebish.org</a></p></p>
<a name="skip-navbar_bottom">
<!-- -->
</a>
</div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>