org.threadly.test.concurrent

Class TestCondition

java.lang.Object

org.threadly.test.concurrent.TestCondition

public class TestCondition
extends java.lang.Object

TestCondition in unit test, designed to check a condition for something that is happening in a different thread. Allowing a test to efficiently block till the testable action has finished.

This tool is used often within threadly's own unit tests. Please use those as examples using this class.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestCondition.ConditionTimeoutException Thrown if condition is still false after a given timeout.

Constructor Summary

Constructors

Constructor and Description
TestCondition() This constructor is expected to have get() overridden, otherwise an exception will be thrown when this condition is checked/used.
TestCondition(java.util.function.Supplier<java.lang.Boolean> condition) Construct a new test condition with a provided supplier for when the state changes.

Method Summary

Modifier and Type	Method and Description
void	blockTillTrue() Blocks till condition is true, useful for asynchronism operations, waiting for them to complete in other threads during unit tests.
void	blockTillTrue(int timeoutInMillis) Blocks till condition is true, useful for asynchronism operations, waiting for them to complete in other threads during unit tests.
void	blockTillTrue(int timeoutInMillis, int pollIntervalInMillis) Blocks till condition is true, useful for asynchronism operations, waiting for them to complete in other threads during unit tests.
boolean	get() Getter for the conditions current state.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestCondition

public TestCondition()

This constructor is expected to have get() overridden, otherwise an exception will be thrown when this condition is checked/used.

TestCondition

public TestCondition(java.util.function.Supplier<java.lang.Boolean> condition)

Construct a new test condition with a provided supplier for when the state changes. Alternatively this can be constructed with TestCondition() and then the condition can be reported by overriding get().

Parameters:

condition - Condition to check

Since:

5.0

Method Detail

get

public boolean get()

Getter for the conditions current state. If constructed with TestCondition() this must be overridden. Otherwise this will return the result from the provided supplier at construction.

Returns:

Test condition state, true if ready

blockTillTrue

public void blockTillTrue()

Blocks till condition is true, useful for asynchronism operations, waiting for them to complete in other threads during unit tests.

This uses a default timeout of 10 seconds, and a poll interval of 10ms

blockTillTrue

public void blockTillTrue(int timeoutInMillis)

Blocks till condition is true, useful for asynchronism operations, waiting for them to complete in other threads during unit tests.

This uses the default poll interval of 10ms

Parameters:

timeoutInMillis - time to wait for value to become true

blockTillTrue

public void blockTillTrue(int timeoutInMillis,
                          int pollIntervalInMillis)

Blocks till condition is true, useful for asynchronism operations, waiting for them to complete in other threads during unit tests.

Parameters:

timeoutInMillis - time to wait for value to become true

pollIntervalInMillis - time to sleep between checks