Package org.awaitility.core

Class ConditionSettings

java.lang.Object

org.awaitility.core.ConditionSettings

public class ConditionSettings
extends java.lang.Object

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

alias

private final java.lang.String alias

waitConstraint

private final WaitConstraint waitConstraint

pollInterval

private final PollInterval pollInterval

pollDelay

private final java.time.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 Detail

ConditionSettings

ConditionSettings(java.lang.String alias,
                  boolean catchUncaughtExceptions,
                  WaitConstraint waitConstraint,
                  PollInterval pollInterval,
                  java.time.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 Detail

getAlias

public java.lang.String getAlias()

Getter for the field alias.

Returns:

a String object.

getMaxWaitTime

public java.time.Duration getMaxWaitTime()

Returning maximum wait time from field waitConstraint.

Returns:

a org.awaitility.Duration object.

getMinWaitTime

public java.time.Duration getMinWaitTime()

Returning minimum wait time from field waitConstraint.

Returns:

a org.awaitility.Duration object.

getHoldPredicateTime

public java.time.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 java.time.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(java.lang.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.