Package org.citrusframework.container

Class AbstractIteratingActionContainer

java.lang.Object

org.citrusframework.actions.AbstractTestAction

org.citrusframework.container.AbstractActionContainer

org.citrusframework.container.AbstractIteratingActionContainer

All Implemented Interfaces:

Described, Named, Completable, TestActionContainer, TestAction, TestActorAware

Direct Known Subclasses:

Iterate, RepeatOnErrorUntilTrue, RepeatUntilTrue

public abstract class AbstractIteratingActionContainer
extends AbstractActionContainer

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	condition	Boolean expression string
protected final IteratingConditionExpression	conditionExpression	Optional condition expression evaluates to true or false
protected int	index	Looping index
protected final String	indexName	Name of index variable
protected final int	start	Cache start index for further container executions - e.g. in loop

Fields inherited from class org.citrusframework.container.AbstractActionContainer

actions

Fields inherited from class org.citrusframework.actions.AbstractTestAction

description

Constructor Summary

Constructors

Constructor	Description
AbstractIteratingActionContainer(String name, AbstractIteratingContainerBuilder<?,?> builder)

Method Summary

Modifier and Type	Method	Description
protected boolean	checkCondition(TestContext context)	Check aborting condition.
final void	doExecute(TestContext context)	Subclasses may add custom execution logic here.
protected void	executeActions(TestContext context)	Executes the nested test actions.
protected abstract void	executeIteration(TestContext context)	Execute embedded actions in loop.
String	getCondition()
IteratingConditionExpression	getConditionExpression()
int	getIndex()
String	getIndexName()
int	getStart()
Duration	getTimeout()	The maximum duration this iteration can take until it reaches a timeout.
boolean	isDone(TestContext context)

Methods inherited from class org.citrusframework.container.AbstractActionContainer

addTestAction, addTestAction, addTestActions, addTestActions, executeAction, getActionCount, getActionIndex, getActions, getActiveAction, getExecutedActions, getTestAction, setActions, setActiveAction, setExecutedAction

Methods inherited from class org.citrusframework.actions.AbstractTestAction

execute, getActor, getDescription, getName, isDisabled, setActor, setDescription, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.citrusframework.TestAction

execute, getActor, getName, isDisabled

Field Details

condition

protected final String condition

Boolean expression string

conditionExpression

protected final IteratingConditionExpression conditionExpression

Optional condition expression evaluates to true or false

index

protected int index

Looping index

indexName

protected final String indexName

Name of index variable

start

protected final int start

Cache start index for further container executions - e.g. in loop

Constructor Details

AbstractIteratingActionContainer

public AbstractIteratingActionContainer(String name,
 AbstractIteratingContainerBuilder<?,?> builder)

Method Details

doExecute

public final void doExecute(TestContext context)

Description copied from class: AbstractTestAction

Subclasses may add custom execution logic here.

Specified by:

doExecute in class AbstractTestAction

isDone

public boolean isDone(TestContext context)

Specified by:

isDone in interface Completable

Overrides:

isDone in class AbstractActionContainer

getCondition

public String getCondition()

Returns:

the condition

getConditionExpression

public IteratingConditionExpression getConditionExpression()

Returns:

the condition expression

getIndex

public int getIndex()

Returns:

the index

getIndexName

public String getIndexName()

Returns:

the index name

getStart

public int getStart()

Returns:

the start index

getTimeout

public Duration getTimeout()

The maximum duration this iteration can take until it reaches a timeout.

executeIteration

protected abstract void executeIteration(TestContext context)

Execute embedded actions in loop.

Parameters:

context - Test context holding variable information.

executeActions

protected void executeActions(TestContext context)

Executes the nested test actions.

Parameters:

context - Test context holding variable information.

checkCondition

protected boolean checkCondition(TestContext context)

Check aborting condition.

Returns:

whether the conditioning has been satisfied.