net.openhft.chronicle.testframework

Class Waiters.WaiterBuilder<T>

java.lang.Object

net.openhft.chronicle.testframework.Waiters.WaiterBuilder<T>

All Implemented Interfaces:

Runnable

Enclosing class:

Waiters

public static class Waiters.WaiterBuilder<T>
extends Object
implements Runnable

Method Summary

Modifier and Type	Method and Description
Waiters.WaiterBuilder<T>	checkIntervalMs(long checkIntervalMs) Specify the interval between checks of the condition.
Waiters.WaiterBuilder<T>	maxTimeToWaitMs(long maxTimeToWaitMs) Specify the maximum amount of time to wait for the condition to be met.
Waiters.WaiterBuilder<T>	message(String message) Specifies a static message for the exception in case the condition isn't met.
Waiters.WaiterBuilder<T>	messageGenerator(Function<T,String> messageGenerator) Supply a function for generating the exception message in case the condition isn't met.
void	run() Wait for the condition to be true, throw an Waiters.ConditionNotMetException if the condition is not met in time.

Methods inherited from class java.lang.Object

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

Method Detail

run

public void run()

Wait for the condition to be true, throw an Waiters.ConditionNotMetException if the condition is not met in time.

This method is overridden from the Runnable interface, allowing the WaiterBuilder to be run as a separate thread.

Specified by:

run in interface Runnable

message

public Waiters.WaiterBuilder<T> message(String message)

Specifies a static message for the exception in case the condition isn't met.

Parameters:

message - the message to be displayed when an exception is thrown.

Returns:

the WaiterBuilder instance to allow for method chaining.

messageGenerator

public Waiters.WaiterBuilder<T> messageGenerator(Function<T,String> messageGenerator)

Supply a function for generating the exception message in case the condition isn't met.

Parameters:

messageGenerator - a function that takes the last value as a parameter to create a message.

Returns:

this WaiterBuilder instance to allow method chaining.

maxTimeToWaitMs

public Waiters.WaiterBuilder<T> maxTimeToWaitMs(long maxTimeToWaitMs)

Specify the maximum amount of time to wait for the condition to be met.

Parameters:

maxTimeToWaitMs - the maximum time in milliseconds to wait for the condition.

Returns:

this WaiterBuilder instance to allow method chaining.

checkIntervalMs

public Waiters.WaiterBuilder<T> checkIntervalMs(long checkIntervalMs)

Specify the interval between checks of the condition. This determines how often the condition is evaluated.

Parameters:

checkIntervalMs - the interval between checks in milliseconds.

Returns:

this WaiterBuilder instance to allow method chaining.