Package org.awaitility.core

Class ConditionSettings

java.lang.Object

org.awaitility.core.ConditionSettings

public class ConditionSettings
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private final String	alias
private final boolean	catchUncaughtExceptions
private final ConditionEvaluationListener	conditionEvaluationListener
private final ExecutorLifecycle	executorLifecycle
private final FailFastCondition	failFastCondition
private final ExceptionIgnorer	ignoreExceptions
private final Duration	pollDelay
private final PollInterval	pollInterval
private final WaitConstraint	waitConstraint

Constructor Summary

Constructors

Constructor	Description
ConditionSettings(String alias, boolean catchUncaughtExceptions, WaitConstraint waitConstraint, PollInterval pollInterval, Duration pollDelay, ConditionEvaluationListener conditionEvaluationListener, ExceptionIgnorer ignoreExceptions, ExecutorLifecycle executorLifecycle, FailFastCondition failFastCondition)	Constructor for ConditionSettings.

Method Summary

Modifier and Type	Method	Description
String	getAlias()	Getter for the field alias.
ConditionEvaluationListener	getConditionEvaluationListener()	Getter for the field conditionResultLogger
ExecutorLifecycle	getExecutorLifecycle()
FailFastCondition	getFailFastCondition()
Duration	getHoldPredicateTime()	Returning hold predicate wait time from field waitConstraint.
Duration	getMaxWaitTime()	Returning maximum wait time from field waitConstraint.
Duration	getMinWaitTime()	Returning minimum wait time from field waitConstraint.
Duration	getPollDelay()	Getter for the field pollDelay.
PollInterval	getPollInterval()	Getter for the field pollInterval.
boolean	hasAlias()	hasAlias
boolean	shouldCatchUncaughtExceptions()	shouldCatchUncaughtExceptions.
boolean	shouldExceptionBeIgnored(Throwable e)

Methods inherited from class java.lang.Object

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

Field Details

alias

private final String alias

waitConstraint

private final WaitConstraint waitConstraint

pollInterval

private final PollInterval pollInterval

pollDelay

private final Duration pollDelay

catchUncaughtExceptions

private final boolean catchUncaughtExceptions

ignoreExceptions

private final ExceptionIgnorer ignoreExceptions

conditionEvaluationListener

private final ConditionEvaluationListener conditionEvaluationListener

executorLifecycle

private final ExecutorLifecycle executorLifecycle

failFastCondition

private final FailFastCondition failFastCondition

Constructor Details

ConditionSettings

ConditionSettings(String alias,
 boolean catchUncaughtExceptions,
 WaitConstraint waitConstraint,
 PollInterval pollInterval,
 Duration pollDelay,
 ConditionEvaluationListener conditionEvaluationListener,
 ExceptionIgnorer ignoreExceptions,
 ExecutorLifecycle executorLifecycle,
 FailFastCondition failFastCondition)

Constructor for ConditionSettings.

Parameters:

alias - a String object.

catchUncaughtExceptions - a boolean.

waitConstraint - a WaitConstraint object.

pollInterval - a org.awaitility.Duration object.

pollDelay - a org.awaitility.Duration object.

conditionEvaluationListener - a ConditionEvaluationListener object.

ignoreExceptions - a ExceptionIgnorer object.

executorLifecycle - Responsible for performing executor service cleanup after each condition evaluation round

failFastCondition - a Callable that if returns true, fails the test immediately

Method Details

getAlias

public String getAlias()

Getter for the field alias.

Returns:

a String object.

getMaxWaitTime

public Duration getMaxWaitTime()

Returning maximum wait time from field waitConstraint.

Returns:

a org.awaitility.Duration object.

getMinWaitTime

public Duration getMinWaitTime()

Returning minimum wait time from field waitConstraint.

Returns:

a org.awaitility.Duration object.

getHoldPredicateTime

public Duration getHoldPredicateTime()

Returning hold predicate wait time from field waitConstraint.

Returns:

a org.awaitility.Duration object.

getPollInterval

public PollInterval getPollInterval()

Getter for the field pollInterval.

Returns:

a org.awaitility.Duration object.

getPollDelay

public Duration getPollDelay()

Getter for the field pollDelay.

Returns:

a org.awaitility.Duration object.

hasAlias

public boolean hasAlias()

hasAlias

Returns:

a boolean.

shouldCatchUncaughtExceptions

public boolean shouldCatchUncaughtExceptions()

shouldCatchUncaughtExceptions.

Returns:

a boolean.

getConditionEvaluationListener

public ConditionEvaluationListener getConditionEvaluationListener()

Getter for the field conditionResultLogger

Returns:

ConditionEvaluationListener object.

shouldExceptionBeIgnored

public boolean shouldExceptionBeIgnored(Throwable e)

Returns:

true if a particular exception should be ignored

getExecutorLifecycle

public ExecutorLifecycle getExecutorLifecycle()

Returns:

The executor lifecycle

getFailFastCondition

public FailFastCondition getFailFastCondition()

Returns:

the fail fast Callable.