Package org.awaitility.pollinterval

Class IterativePollInterval

java.lang.Object

org.awaitility.pollinterval.IterativePollInterval

All Implemented Interfaces:

PollInterval

public class IterativePollInterval
extends Object
implements PollInterval

A poll interval that is generated by a function and a start duration. The function is free to do anything with the duration. For example:

 await().with().pollInterval(iterative(duration -> duration.multiply(2)), Duration.FIVE_HUNDRED_MILLISECONDS).until(..);
 

This generates a poll interval sequence that looks like this (ms): 500, 1000, 2000, 4000, 8000, 16000, ...

Note that if the user specifies a poll delay this delay will take place before the first call to next(int, Duration).

Field Summary

Fields

Modifier and Type	Field	Description
private final Function<Duration,Duration>	function
private final Duration	startDuration

Constructor Summary

Constructors

Modifier	Constructor	Description
	IterativePollInterval(Function<Duration,Duration> function)	Generate an iterative poll interval based on the supplied function.
	IterativePollInterval(Function<Duration,Duration> function, Duration startDuration)	Generate a iterative poll interval based on the supplied function and start duration.
private	IterativePollInterval(Function<Duration,Duration> function, Duration startDuration, boolean startDurationExplicitlyDefined)	Generate a iterative poll interval based on the supplied function and start duration.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
static IterativePollInterval	iterative(Function<Duration,Duration> function)	Syntactic sugar for creating a IterativePollInterval.
static IterativePollInterval	iterative(Function<Duration,Duration> function, Duration startDuration)	Syntactic sugar for creating a IterativePollInterval.
Duration	next(int pollCount, Duration previousDuration)	Generate the next Duration based on the supplied function.
IterativePollInterval	startDuration(Duration duration)	Set the start duration of this poll interval
String	toString()
IterativePollInterval	with()	Syntactic sugar

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

function

private final Function<Duration,Duration> function

startDuration

private final Duration startDuration

Constructor Details

IterativePollInterval

public IterativePollInterval(Function<Duration,Duration> function)

Generate an iterative poll interval based on the supplied function.

Parameters:

function - The function to use.

IterativePollInterval

public IterativePollInterval(Function<Duration,Duration> function,
 Duration startDuration)

Generate a iterative poll interval based on the supplied function and start duration.

Parameters:

function - The function to use.

startDuration - The start duration (initial function value)

IterativePollInterval

private IterativePollInterval(Function<Duration,Duration> function,
 Duration startDuration,
 boolean startDurationExplicitlyDefined)

Generate a iterative poll interval based on the supplied function and start duration.

Parameters:

function - The function to use.

startDuration - The start duration (initial function value)

Method Details

next

public Duration next(int pollCount,
 Duration previousDuration)

Generate the next Duration based on the supplied function. If you've specified a start duration explicitly then this start duration will override the value of previousDuration when pollCount is 1 (i.e. the poll delay).

Specified by:

next in interface PollInterval

Parameters:

pollCount - The number of times the condition has been polled (evaluated). Always a positive integer.

previousDuration - The duration of the previously returned poll interval.

Returns:

The duration of the next poll interval

iterative

public static IterativePollInterval iterative(Function<Duration,Duration> function)

Syntactic sugar for creating a IterativePollInterval.

Parameters:

function - The function to use

Returns:

A new instance of IterativePollInterval

iterative

public static IterativePollInterval iterative(Function<Duration,Duration> function,
 Duration startDuration)

Syntactic sugar for creating a IterativePollInterval.

Parameters:

function - The function to use

startDuration - The start duration (initial function value)

Returns:

A new instance of IterativePollInterval

with

public IterativePollInterval with()

Syntactic sugar

Returns:

The same of instance of IterativePollInterval

startDuration

public IterativePollInterval startDuration(Duration duration)

Set the start duration of this poll interval

Returns:

A new of instance of IterativePollInterval with the given start duration

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object