net.joala.condition.timing

Interface Wait

All Known Implementing Classes:

DeceleratingWait

public interface Wait

Wait until an expectation is met. Validate the expectation with decelerating polling intervals.

Since:

9/14/12

Method Summary

Modifier and Type	Method and Description
<F,T> T	until(F input, com.google.common.base.Function<? super F,T> stateQuery) Wait until the given input passes its state query without ignorable exception.
<F,T> T	until(F input, com.google.common.base.Function<? super F,T> stateQuery, org.hamcrest.Matcher<? super T> matcher) Wait until an expectation is met.
<F,T> T	until(String message, F input, com.google.common.base.Function<? super F,T> stateQuery, org.hamcrest.Matcher<? super T> matcher) Wait until an expectation is met.

Method Detail

until

<F,T> T until(@Nonnull
              F input,
              @Nonnull
              com.google.common.base.Function<? super F,T> stateQuery)

Wait until the given input passes its state query without ignorable exception.

This call is equal to:

 until(null, input, stateQuery, null)
 

Type Parameters:

F - the input type

T - the return type of the state query

Parameters:

input - the input to pass to the query function; if implementing SelfDescribing the description of input will be queried on failure

stateQuery - the function to query the state of input; if implementing SelfDescribing the description of stateQuery will be queried on failure

Returns:

the result of the successful state query

See Also:

IgnorableStateQueryException

until

<F,T> T until(@Nonnull
              F input,
              @Nonnull
              com.google.common.base.Function<? super F,T> stateQuery,
              @Nullable
              org.hamcrest.Matcher<? super T> matcher)

Wait until an expectation is met. Validate the expectation with decelerating polling intervals.

Type Parameters:

F - the input type

T - the return type of the state query

Parameters:

input - the input to pass to the query function; if implementing SelfDescribing the description of input will be queried on failure

stateQuery - the function to query the state of input; if implementing SelfDescribing the description of stateQuery will be queried on failure

matcher - the matcher to validate the result of the query; null to match any returned value

Returns:

the result of the successful state query

until

<F,T> T until(@Nullable
              String message,
              @Nonnull
              F input,
              @Nonnull
              com.google.common.base.Function<? super F,T> stateQuery,
              @Nullable
              org.hamcrest.Matcher<? super T> matcher)

Wait until an expectation is met. Validate the expectation with decelerating polling intervals.

Type Parameters:

F - the input type

T - the return type of the state query

Parameters:

message - the message to print on failure; null for no additional message

input - the input to pass to the query function; if implementing SelfDescribing the description of input will be queried on failure

stateQuery - the function to query the state of input; if implementing SelfDescribing the description of stateQuery will be queried on failure

matcher - the matcher to validate the result of the query; null to match any returned value

Returns:

the result of the successful state query