org.awaitility.core

Class EvaluatedCondition<T>

java.lang.Object

org.awaitility.core.EvaluatedCondition<T>

Type Parameters:

T - The condition evaluation result value type.

public class EvaluatedCondition<T>
extends Object

Contains properties of the condition at its current stage.

Method Summary

Modifier and Type	Method and Description
String	getAlias()
String	getDescription()
long	getElapsedTimeInMS()
org.hamcrest.Matcher<? super T>	getMatcher()
Duration	getPollInterval()
long	getRemainingTimeInMS()
T	getValue()
boolean	hasAlias()
boolean	isConditionRunningForever()
boolean	isHamcrestCondition()
boolean	isSatisfied()

Methods inherited from class java.lang.Object

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

Method Detail

getDescription

public String getDescription()

Returns:

Descriptive message of the Hamcrest matcher.

isHamcrestCondition

public boolean isHamcrestCondition()

Returns:

true if the condition has a matcher (i.e. it's a Hamcrest Based condition) which means that getMatcher() will return a non-null value.

getMatcher

public org.hamcrest.Matcher<? super T> getMatcher()

Returns:

The Hamcrest matcher used in the condition if this condition is a Hamcrest condition

See Also:

isHamcrestCondition()

getValue

public T getValue()

Returns:

The current value of the condition.

getElapsedTimeInMS

public long getElapsedTimeInMS()

Returns:

Elapsed time in milliseconds.

getRemainingTimeInMS

public long getRemainingTimeInMS()

Returns:

Remaining time to wait in milliseconds or Long.MAX_VALUE if no timeout defined, i.e., running forever.

isConditionRunningForever

public boolean isConditionRunningForever()

Returns:

true if the condition doesn't have a timeout, false otherwise.

isSatisfied

public boolean isSatisfied()

Returns:

true if the condition is satisfied (i.e. hamcrest matcher matches the value), false otherwise (i.e. an intermediate value).

getAlias

public String getAlias()

Returns:

The Awaitility alias for the condition (if any).

See Also:

hasAlias()

hasAlias

public boolean hasAlias()

Returns:

true if this condition defined an alias.

See Also:

getAlias()

getPollInterval

public Duration getPollInterval()

Returns:

The poll interval for the evaluation round