org.awaitility.pollinterval

Class FibonacciPollInterval

java.lang.Object

org.awaitility.pollinterval.FibonacciPollInterval

All Implemented Interfaces:

PollInterval

public class FibonacciPollInterval
extends Object
implements PollInterval

Generates a non-linear poll interval based on the fibonacci sequence: [0, 1, 1, 2, 3, 5, 8, 13, ..]

Constructor Summary

Constructors

Constructor and Description
FibonacciPollInterval() Create an instance of the FibonacciPollInterval with the time unit of TimeUnit.MILLISECONDS.
FibonacciPollInterval(int offset, TimeUnit unit) Create an instance of the FibonacciPollInterval with a supplied time unit.
FibonacciPollInterval(TimeUnit unit) Create an instance of the FibonacciPollInterval with the supplied time unit starting with offset equal to .

Method Summary

Modifier and Type	Method and Description
FibonacciPollInterval	and() Syntactic sugar
boolean	equals(Object o)
static FibonacciPollInterval	fibonacci() Syntactic sugar for new FibonacciPollInterval()
protected int	fibonacci(int value) Generate the value of the fibonacci sequence for number.
static FibonacciPollInterval	fibonacci(int offset, TimeUnit unit) Syntactic sugar for new FibonacciPollInterval(offset, unit)
static FibonacciPollInterval	fibonacci(TimeUnit unit) Syntactic sugar for new FibonacciPollInterval(unit)
int	hashCode()
Duration	next(int pollCount, Duration previousDuration) Generate the next duration
FibonacciPollInterval	offset(int offset) Create a new FibonacciPollInterval with the same time unit but with a different offset
String	toString()
FibonacciPollInterval	unit(TimeUnit unit) Create a new FibonacciPollInterval with the same offset but with a different time unit
FibonacciPollInterval	with() Syntactic sugar

Methods inherited from class java.lang.Object

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

Constructor Detail

FibonacciPollInterval

public FibonacciPollInterval()

Create an instance of the FibonacciPollInterval with the time unit of TimeUnit.MILLISECONDS.

FibonacciPollInterval

public FibonacciPollInterval(TimeUnit unit)

Create an instance of the FibonacciPollInterval with the supplied time unit starting with offset equal to .

Parameters:

unit - The time unit

See Also:

FibonacciPollInterval(int, TimeUnit)

FibonacciPollInterval

public FibonacciPollInterval(int offset,
                             TimeUnit unit)

Create an instance of the FibonacciPollInterval with a supplied time unit.

Parameters:

offset - The fibonacci offset. For example if offset is 5 and poll count is 1 then the returned duration will be 8 (since fib(6) is equal to 8). Default offset is . You can set the offset to -1 if you want the first value to be fib(0) (i.e. pollCount - offset). By default the first value will be fib(1).

unit - The time unit

Method Detail

next

public Duration next(int pollCount,
                     Duration previousDuration)

Generate the next duration

Specified by:

next in interface PollInterval

Parameters:

pollCount - The number of times the condition has been polled (evaluated)

previousDuration - The duration of the previously returned poll interval

Returns:

The next duration in the fibonacci sequence.

fibonacci

public static FibonacciPollInterval fibonacci()

Syntactic sugar for new FibonacciPollInterval()

Returns:

A new instance of FibonacciPollInterval.

fibonacci

public static FibonacciPollInterval fibonacci(TimeUnit unit)

Syntactic sugar for new FibonacciPollInterval(unit)

Parameters:

unit - The time unit

Returns:

A new instance of FibonacciPollInterval.

fibonacci

public static FibonacciPollInterval fibonacci(int offset,
                                              TimeUnit unit)

Syntactic sugar for new FibonacciPollInterval(offset, unit)

Parameters:

offset - The fibonacci offset. For example if offset is 5 and poll count is 1 then the returned duration will be 8 (since fib(6) is equal to 8). Default offset is .

unit - The time unit

Returns:

A new instance of FibonacciPollInterval.

with

public FibonacciPollInterval with()

Syntactic sugar

Returns:

The same of instance of FibonacciPollInterval

and

public FibonacciPollInterval and()

Syntactic sugar

Returns:

The same of instance of FibonacciPollInterval

unit

public FibonacciPollInterval unit(TimeUnit unit)

Create a new FibonacciPollInterval with the same offset but with a different time unit

Returns:

The same of instance of FibonacciPollInterval

offset

public FibonacciPollInterval offset(int offset)

Create a new FibonacciPollInterval with the same time unit but with a different offset

Returns:

The same of instance of FibonacciPollInterval

fibonacci

protected int fibonacci(int value)

Generate the value of the fibonacci sequence for number.

Parameters:

value - The value

Returns:

the fibonacci number

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