Package spock.util.concurrent

Class PollingConditions

java.lang.Object

spock.util.concurrent.PollingConditions

@Beta
public class PollingConditions
extends java.lang.Object

Repeatedly evaluates one or more conditions until they are satisfied or a timeout has elapsed. The timeout and delays between evaluation attempts are configurable. All durations are in seconds.

Usage example:

 def conditions = new PollingConditions(timeout: 10, initialDelay: 1.5, factor: 1.25)
 def machine = new Machine()

 when:
 machine.start()

 then:
 conditions.eventually {
   assert machine.temperature >= 100
   assert machine.efficiency >= 0.9
 }
 

Constructor Summary

Constructors

Constructor	Description
PollingConditions()

Method Summary

Modifier and Type	Method	Description
void	call(double seconds, Closure<?> conditions)	Alias for within(double, groovy.lang.Closure).
void	call(Closure<?> conditions)	Alias for eventually(groovy.lang.Closure).
void	eventually(Closure<?> conditions)	Repeatedly evaluates the specified conditions until they are satisfied or the timeout has elapsed.
double	getDelay()	Returns the delay (in seconds) between successive evaluations of the conditions.
double	getFactor()	Returns the factor by which the delay grows (or shrinks) after each evaluation of the conditions.
double	getInitialDelay()	Returns the initial delay (in seconds) before first evaluating the conditions.
double	getTimeout()	Returns the timeout (in seconds) until which the conditions have to be satisfied.
void	setDelay(double seconds)	Sets the delay (in seconds) between successive evaluations of the conditions.
void	setFactor(double factor)	Sets the factor by which the delay grows (or shrinks) after each evaluation of the conditions.
void	setInitialDelay(double seconds)	Sets the initial delay (in seconds) before first evaluating the conditions.
void	setTimeout(double seconds)	Sets the timeout (in seconds) until which the conditions have to be satisfied.
void	within(double seconds, Closure<?> conditions)	Repeatedly evaluates the specified conditions until they are satisfied or the specified timeout (in seconds) has elapsed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PollingConditions

public PollingConditions()

Method Detail

getTimeout

public double getTimeout()

Returns the timeout (in seconds) until which the conditions have to be satisfied. Defaults to one second.

Returns:

the timeout (in seconds) until which the conditions have to be satisfied

setTimeout

public void setTimeout(double seconds)

Sets the timeout (in seconds) until which the conditions have to be satisfied. Defaults to one second.

Parameters:

seconds - the timeout (in seconds) until which the conditions have to be satisfied

getInitialDelay

public double getInitialDelay()

Returns the initial delay (in seconds) before first evaluating the conditions. Defaults to zero seconds.

setInitialDelay

public void setInitialDelay(double seconds)

Sets the initial delay (in seconds) before first evaluating the conditions. Defaults to zero seconds.

Parameters:

seconds - the initial delay (in seconds) before first evaluating the conditions

getDelay

public double getDelay()

Returns the delay (in seconds) between successive evaluations of the conditions. Defaults to 0.1 seconds.

setDelay

public void setDelay(double seconds)

Sets the delay (in seconds) between successive evaluations of the conditions. Defaults to 0.1 seconds.

Parameters:

seconds - the delay (in seconds) between successive evaluations of the conditions.

getFactor

public double getFactor()

Returns the factor by which the delay grows (or shrinks) after each evaluation of the conditions. Defaults to 1.

setFactor

public void setFactor(double factor)

Sets the factor by which the delay grows (or shrinks) after each evaluation of the conditions. Defaults to 1.

Parameters:

factor - the factor by which the delay grows (or shrinks) after each evaluation of the conditions

eventually

public void eventually(Closure<?> conditions)
                throws java.lang.InterruptedException

Repeatedly evaluates the specified conditions until they are satisfied or the timeout has elapsed.

Parameters:

conditions - the conditions to evaluate

Throws:

java.lang.InterruptedException - if evaluation is interrupted

within

public void within(double seconds,
                   Closure<?> conditions)
            throws java.lang.InterruptedException

Repeatedly evaluates the specified conditions until they are satisfied or the specified timeout (in seconds) has elapsed.

Parameters:

conditions - the conditions to evaluate

Throws:

java.lang.InterruptedException - if evaluation is interrupted

call

public void call(Closure<?> conditions)
          throws java.lang.InterruptedException

Alias for eventually(groovy.lang.Closure).

Throws:

java.lang.InterruptedException

call

public void call(double seconds,
                 Closure<?> conditions)
          throws java.lang.InterruptedException

Alias for within(double, groovy.lang.Closure).

Throws:

java.lang.InterruptedException