Iterate (Citrus :: Core :: Base 3.1.0 API)

java.lang.Object
- com.consol.citrus.actions.AbstractTestAction
- - com.consol.citrus.container.AbstractActionContainer
  - - com.consol.citrus.container.AbstractIteratingActionContainer
    - - com.consol.citrus.container.Iterate

All Implemented Interfaces:

com.consol.citrus.common.Described, com.consol.citrus.common.Named, com.consol.citrus.Completable, com.consol.citrus.container.TestActionContainer, com.consol.citrus.TestAction, com.consol.citrus.TestActorAware
```
public class Iterate
extends AbstractIteratingActionContainer
```
Class executes nested test actions in loops. Iteration continues as long as looping condition evaluates to true. Each loop an index variable is incremented. The index variable is accessible inside the nested test actions as normal test variable. Iteration starts with index=1 and increments with a default step=1.

Author:

Christoph Deppisch

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Iterate.Builder
Action builder.

Field Summary
- Fields inherited from class com.consol.citrus.container.AbstractIteratingActionContainer
  condition, conditionExpression, index, indexName, start
- Fields inherited from class com.consol.citrus.container.AbstractActionContainer
  actions, log
- Fields inherited from class com.consol.citrus.actions.AbstractTestAction
  description

Constructor Summary

Constructors
Constructor Description

Iterate(Iterate.Builder builder)
Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`executeIteration(com.consol.citrus.context.TestContext context)`	Execute embedded actions in loop.
`int`	`getStep()`	Gets the step.

Methods inherited from class com.consol.citrus.container.AbstractIteratingActionContainer
checkCondition, doExecute, executeActions, getCondition, getConditionExpression, getIndex, getIndexName, getStart, isDone

Methods inherited from class com.consol.citrus.container.AbstractActionContainer
addTestAction, addTestAction, addTestActions, addTestActions, getActionCount, getActionIndex, getActions, getActiveAction, getExecutedActions, getTestAction, setActions, setActiveAction

Methods inherited from class com.consol.citrus.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 com.consol.citrus.TestAction
execute, getActor, getName, isDisabled

- Constructor Detail
  - Iterate
```
public Iterate(Iterate.Builder builder)
```
    Default constructor.
- Method Detail
  - executeIteration
```
public void executeIteration(com.consol.citrus.context.TestContext context)
```
    Description copied from class: AbstractIteratingActionContainer
    
    Execute embedded actions in loop.
    
    Specified by:
    
    executeIteration in class AbstractIteratingActionContainer
    
    Parameters:
    
    context - TestContext holding variable information.
  - getStep
```
public int getStep()
```
    Gets the step.
    
    Returns:
    
    the step