Package org.awaitility.core

Class ConditionEvaluationLogger

java.lang.Object

org.awaitility.core.ConditionEvaluationLogger

All Implemented Interfaces:

ConditionEvaluationListener<Object>

public class ConditionEvaluationLogger
extends Object
implements ConditionEvaluationListener<Object>

Simple implementation of ConditionEvaluationListener that prints the condition evaluation results to the console using System.out.println by default. You can customize the how the results are written by providing a custom consumer that prints the results.

Field Summary

Fields

Modifier and Type	Field	Description
private final Consumer<String>	logPrinter
private final TimeUnit	unit

Constructor Summary

Constructors

Constructor	Description
ConditionEvaluationLogger()	Uses TimeUnit.MILLISECONDS as unit for elapsed and remaining time.
ConditionEvaluationLogger(TimeUnit unit)	Specifies the TimeUnit to use as unit for elapsed and remaining time.
ConditionEvaluationLogger(Consumer<String> logPrinter)	Specifies a consumer that is responsible for actually printing the logs
ConditionEvaluationLogger(Consumer<String> logPrinter, TimeUnit unit)

Method Summary

Modifier and Type	Method	Description
void	beforeEvaluation(StartEvaluationEvent<Object> condition)	Handle the startEvaluationEvent.
void	conditionEvaluated(EvaluatedCondition<Object> condition)	Handle an evaluated condition of a matcher.
static ConditionEvaluationLogger	conditionEvaluationLogger()	Syntactic sugar to avoid writing the new keyword in Java.
static ConditionEvaluationLogger	conditionEvaluationLogger(TimeUnit unit)	Syntactic sugar to avoid writing the new keyword in Java.
static ConditionEvaluationLogger	conditionEvaluationLogger(Consumer<String> logger)	Syntactic sugar to avoid writing the new keyword in Java.
void	exceptionIgnored(IgnoredException ignoredException)	Handle ignored exception that get thrown while condition evaluation.
void	onTimeout(TimeoutEvent timeoutEvent)	Handle the timeoutEvent.

Methods inherited from class java.lang.Object

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

Field Details

logPrinter

private final Consumer<String> logPrinter

unit

private final TimeUnit unit

Constructor Details

ConditionEvaluationLogger

public ConditionEvaluationLogger()

Uses TimeUnit.MILLISECONDS as unit for elapsed and remaining time.

ConditionEvaluationLogger

public ConditionEvaluationLogger(Consumer<String> logPrinter)

Specifies a consumer that is responsible for actually printing the logs

Parameters:

logPrinter - The logger to use

ConditionEvaluationLogger

public ConditionEvaluationLogger(TimeUnit unit)

Specifies the TimeUnit to use as unit for elapsed and remaining time.

Parameters:

unit - The time unit to use.

ConditionEvaluationLogger

public ConditionEvaluationLogger(Consumer<String> logPrinter,
 TimeUnit unit)

Method Details

conditionEvaluated

public void conditionEvaluated(EvaluatedCondition<Object> condition)

Description copied from interface: ConditionEvaluationListener

Handle an evaluated condition of a matcher.

Specified by:

conditionEvaluated in interface ConditionEvaluationListener<Object>

Parameters:

condition - The condition evaluation result containing various properties of the result of evaluated condition

beforeEvaluation

public void beforeEvaluation(StartEvaluationEvent<Object> condition)

Description copied from interface: ConditionEvaluationListener

Handle the startEvaluationEvent. Method is default to keep the ConditionEvaluationListener backward compatible.

Specified by:

beforeEvaluation in interface ConditionEvaluationListener<Object>

Parameters:

condition - the event containing various properties of the condition evaluation to be started

onTimeout

public void onTimeout(TimeoutEvent timeoutEvent)

Description copied from interface: ConditionEvaluationListener

Handle the timeoutEvent. Method is default to keep the ConditionEvaluationListener backward compatible.

Specified by:

onTimeout in interface ConditionEvaluationListener<Object>

Parameters:

timeoutEvent - the event containing some properties about the condition evaluation timeout

exceptionIgnored

public void exceptionIgnored(IgnoredException ignoredException)

Description copied from interface: ConditionEvaluationListener

Handle ignored exception that get thrown while condition evaluation. Method is default to keep the ConditionEvaluationListener backward compatible.

Specified by:

exceptionIgnored in interface ConditionEvaluationListener<Object>

Parameters:

ignoredException - contains the ignored Throwable and various properties of the evaluation

conditionEvaluationLogger

public static ConditionEvaluationLogger conditionEvaluationLogger(Consumer<String> logger)

Syntactic sugar to avoid writing the new keyword in Java. Uses TimeUnit.MILLISECONDS as unit for elapsed and remaining time.

Returns:

A new instance of ConditionEvaluationLogger

conditionEvaluationLogger

public static ConditionEvaluationLogger conditionEvaluationLogger()

Syntactic sugar to avoid writing the new keyword in Java. Uses TimeUnit.MILLISECONDS as unit for elapsed and remaining time.

Returns:

A new instance of ConditionEvaluationLogger

conditionEvaluationLogger

public static ConditionEvaluationLogger conditionEvaluationLogger(TimeUnit unit)

Syntactic sugar to avoid writing the new keyword in Java. Specifies the TimeUnit to use as unit for elapsed and remaining time.

Parameters:

unit - The time unit to use.