Represents a particular configuration of waiting, but does not encompass what is to be waited on.
Generally not used by user code, but used internally by Configuration and WaitingSupport.
Modifiers | Name | Description |
---|---|---|
static Double |
DEFAULT_RETRY_INTERVAL |
100 milliseconds |
static Double |
DEFAULT_TIMEOUT |
5 seconds |
Type | Name and description |
---|---|
String |
customMessage |
boolean |
includeCauseInExceptionMessage Whether we should append cause strings to the returned exception message or not |
Double |
retryInterval How many seconds to wait before trying something again while waiting. |
Double |
timeout The maximum amount of seconds that something can be waited on. |
Type Params | Return Type | Name and description |
---|---|---|
|
Date |
calculateTimeoutFrom(Date start) |
|
Date |
calculateTimeoutFromNow() |
|
boolean |
equals(def other) |
|
int |
hashCode() |
|
void |
sleepForRetryInterval() Blocks the caller for the retryInterval |
|
String |
toString() |
<T> |
T |
waitFor(Closure<T> block) Invokes the given block every retryInterval seconds until it returns
a true value according to the Groovy Truth. |
100 milliseconds
5 seconds
Whether we should append cause strings to the returned exception message or not
How many seconds to wait before trying something again while waiting.
The maximum amount of seconds that something can be waited on.
Blocks the caller for the retryInterval
Invokes the given block
every retryInterval
seconds until it returns
a true value according to the Groovy Truth. If block
does not return a truish value
within timeout
seconds then a WaitTimeoutException will be thrown.
If the given block is executing at the time when the timeout is reached, it will not be interrupted. This means that
this method may take longer than the specified timeout
. For example, if the block
takes 5 seconds
to complete but the timeout is 2 seconds, the wait is always going to take at least 5 seconds.
If block
throws any Throwable, it is treated as a failure and the block
will be tried
again after the retryInterval
has expired. If the last invocation of block
throws an exception
it will be the cause of the WaitTimeoutException that will be thrown.
Groovy API Documentation for Geb 2.2 - Licensed under the Apache License, Version 2.0 - http://www.gebish.org