net.joala.condition

Interface Condition<T>

Type Parameters:

T - the type of the value which will be verified

All Known Subinterfaces:

BooleanCondition, FailSafeCondition<T>

All Known Implementing Classes:

DefaultBooleanCondition, DefaultCondition

public interface Condition<T>

A test condition to wait for using a given timeout. If the condition does not become true within time exceptions will be thrown.

Since:

2/24/12

Method Summary

Modifier and Type	Method and Description
void	assertEquals(T expected) Assert that the condition evaluates to the expected value within a given time.
void	assertThat(org.hamcrest.Matcher<? super T> matcher) Uses Matcher to assert that a condition is met in time.
void	assumeEquals(T expected) Assumes that the condition evaluates to the expected value within a given time.
void	assumeThat(org.hamcrest.Matcher<? super T> matcher) Uses Matcher to assume that a condition is met in time.
T	await() Retrieve the result of the condition as soon as it is evaluated without any exception.
T	await(org.hamcrest.Matcher<? super T> matcher) Wait for the condition value until it fulfills the given matcher and return it.
T	get() Conditions need to implement this method to return the value which will be checked.
void	waitUntil(org.hamcrest.Matcher<? super T> matcher) Uses Matcher to wait until a condition is met in time.
void	waitUntilEquals(T expected) Wait until the condition evaluates to the expected value within a given time.
Condition<T>	withMessage(String message) The message to print on failure.
Condition<T>	withTimeoutFactor(double factor) Sets a factor to speed up or slow down tests.

Method Detail

get

T get()

Conditions need to implement this method to return the value which will be checked.

Returns:

the value

Throws:

ExpressionEvaluationException - when the actual value cannot be evaluated. Consider calling any of the await or assume methods to wait for the value to become available.

See Also:

Expression.get()

await

T await()

Retrieve the result of the condition as soon as it is evaluated without any exception.

Returns:

the retrieved value

Throws:

WaitTimeoutException - if a value could not be retrieved in time

await

T await(@Nonnull
        org.hamcrest.Matcher<? super T> matcher)

Wait for the condition value until it fulfills the given matcher and return it.

Parameters:

matcher - matcher to use

Returns:

the value which fulfills the given matcher

Throws:

WaitTimeoutException - if a value could not be retrieved in time

assumeEquals

void assumeEquals(@Nullable
                  T expected)

Assumes that the condition evaluates to the expected value within a given time.

Parameters:

expected - expected value

assumeThat

void assumeThat(@Nonnull
                org.hamcrest.Matcher<? super T> matcher)

Uses Matcher to assume that a condition is met in time.

Parameters:

matcher - the matcher to use

assertEquals

void assertEquals(@Nullable
                  T expected)

Assert that the condition evaluates to the expected value within a given time.

Parameters:

expected - expected value

assertThat

void assertThat(@Nonnull
                org.hamcrest.Matcher<? super T> matcher)

Uses Matcher to assert that a condition is met in time.

Parameters:

matcher - the matcher to use

waitUntilEquals

void waitUntilEquals(@Nullable
                     T expected)

Wait until the condition evaluates to the expected value within a given time.

Parameters:

expected - expected value

waitUntil

void waitUntil(@Nonnull
               org.hamcrest.Matcher<? super T> matcher)

Uses Matcher to wait until a condition is met in time.

Parameters:

matcher - the matcher to use

withTimeoutFactor

@Nonnull
Condition<T> withTimeoutFactor(@Nonnegative
                                         double factor)

Sets a factor to speed up or slow down tests. If < 1.0 the tests will speed up at least for failures while a number > 1.0 increases the time to wait for the condition by the given factor.

Parameters:

factor - factor by which to increase the timeout for this condition

Returns:

a self-reference.

withMessage

@Nonnull
Condition<T> withMessage(@Nullable
                                   String message)

The message to print on failure.

Parameters:

message - message with debugging hints; null to remove the message

Returns:

self-reference