Package org.citrusframework.container

Class Template

java.lang.Object

org.citrusframework.actions.AbstractTestAction

org.citrusframework.container.Template

All Implemented Interfaces:

Described, Named, TestAction, TestActorAware

public class Template
extends AbstractTestAction

This class represents a previously defined block of test actions. Test cases can call templates and reuse their functionality. Templates operate on test variables. While calling, the template caller can set these variables as parameters. Nested test actions are executed in sequence. The template execution may affect existing variable values in the calling test case. So variables may have different values in the test case after template execution. Therefore, users can create a local test context by setting globalContext to false. Templates then will have no effect on the variables used in the test case.

Since:

2007

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Template.AbstractTemplateBuilder<T extends Template,B extends Template.AbstractTemplateBuilder<T,B>>	Action builder.
static class	Template.Builder	Action builder.

Field Summary

Fields inherited from class org.citrusframework.actions.AbstractTestAction

description

Constructor Summary

Constructors

Constructor	Description
Template(Template.AbstractTemplateBuilder<? extends Template,?> builder)	Default constructor

Method Summary

Modifier and Type	Method	Description
void	doExecute(TestContext context)	Subclasses may add custom execution logic here.
List<TestActionBuilder<?>>	getActionBuilders()	Gets the list of action builders.
List<TestAction>	getActions()	Gets the actions.
Map<String,String>	getParameter()	Gets the parameter.
String	getTemplateName()
boolean	isGlobalContext()	Gets the globalContext.

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

Constructor Details

Template

public Template(Template.AbstractTemplateBuilder<? extends Template,?> builder)

Default constructor

Parameters:

builder -

Method Details

doExecute

public void doExecute(TestContext context)

Description copied from class: AbstractTestAction

Subclasses may add custom execution logic here.

Specified by:

doExecute in class AbstractTestAction

getParameter

public Map<String,String> getParameter()

Gets the parameter.

Returns:

the parameter

isGlobalContext

public boolean isGlobalContext()

Gets the globalContext.

Returns:

the globalContext

getActions

public List<TestAction> getActions()

Gets the actions.

Returns:

the actions

getActionBuilders

public List<TestActionBuilder<?>> getActionBuilders()

Gets the list of action builders.

Returns:

the action builders.

getTemplateName

public String getTemplateName()