Groovy Documentation

geb.waiting
[Groovy] Class Wait

java.lang.Object
  geb.waiting.Wait

class Wait
extends Object

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.

See Also:
waitFor(Closure)


Field Summary
static Double DEFAULT_RETRY_INTERVAL

100 milliseconds

static Double DEFAULT_TIMEOUT

5 seconds

 
Property Summary
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.

 
Constructor Summary
Wait(Double timeout = DEFAULT_TIMEOUT, Double retryInterval = DEFAULT_RETRY_INTERVAL)

 
Method Summary
Date calculateTimeoutFrom(Date start)

Date calculateTimeoutFromNow()

boolean equals(def other)

int hashCode()

void sleepForRetryInterval()

Blocks the caller for the retryInterval

String toString()

def waitFor(Closure block)

Invokes the given block every retryInterval seconds until it returns a true value according to the Groovy Truth.

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

DEFAULT_RETRY_INTERVAL

public static final Double DEFAULT_RETRY_INTERVAL
100 milliseconds


DEFAULT_TIMEOUT

public static final Double DEFAULT_TIMEOUT
5 seconds


 
Property Detail

retryInterval

final Double retryInterval
How many seconds to wait before trying something again while waiting.


timeout

final Double timeout
The maximum amount of seconds that something can be waited on.


 
Constructor Detail

Wait

Wait(Double timeout = DEFAULT_TIMEOUT, Double retryInterval = DEFAULT_RETRY_INTERVAL)


 
Method Detail

calculateTimeoutFrom

Date calculateTimeoutFrom(Date start)


calculateTimeoutFromNow

Date calculateTimeoutFromNow()


equals

boolean equals(def other)


hashCode

int hashCode()


sleepForRetryInterval

void sleepForRetryInterval()
Blocks the caller for the retryInterval


toString

String toString()


waitFor

def waitFor(Closure block)
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-core 0.6.3 - Licensed under the Apache License, Version 2.0 - http://www.gebish.org