com.consol.citrus.dsl.builder

Class WaitBuilder

java.lang.Object

com.consol.citrus.dsl.builder.AbstractTestActionBuilder<T>

com.consol.citrus.dsl.builder.AbstractTestContainerBuilder<Wait>

com.consol.citrus.dsl.builder.WaitBuilder

All Implemented Interfaces:

TestActionBuilder<Wait>, TestActionContainerBuilder<Wait>, TestAction

public class WaitBuilder
extends AbstractTestContainerBuilder<Wait>

Wait action pauses test execution until a condition is satisfied. If the condition is not satisfied after the configured timeout then the test exits with an error.

Since:

2.4

Field Summary

Fields inherited from class com.consol.citrus.dsl.builder.AbstractTestContainerBuilder

container, designer, runner

Fields inherited from class com.consol.citrus.dsl.builder.AbstractTestActionBuilder

action

Constructor Summary

Constructors

Constructor and Description
WaitBuilder(TestDesigner designer, Wait action, Stack<AbstractActionContainer> containers) Constructor using designer and action field.
WaitBuilder(TestRunner runner, Wait action) Constructor using runner and action field.

Method Summary

Modifier and Type	Method and Description
Wait	buildAndRun() Finishes action build process.
Wait	condition(Condition condition) Condition to wait for during execution.
WaitActionConditionBuilder	execution() The test action condition to wait for during execution.
WaitFileConditionBuilder	file() The file condition to wait for during execution.
WaitFileConditionBuilder	file(File file) Deprecated. in favor of file()
WaitFileConditionBuilder	file(String filePath) Deprecated. in favor of file()
WaitHttpConditionBuilder	http() The HTTP condition to wait for during execution.
WaitHttpConditionBuilder	http(String url) Deprecated. in favor of http()
WaitBuilder	interval(Long interval) The interval in seconds to use between each test of the condition
WaitBuilder	interval(String interval) The interval in seconds to use between each test of the condition
WaitMessageConditionBuilder	message() The message condition to wait for during execution.
WaitConditionBuilder	message(String name) Deprecated. in favor of message()
WaitBuilder	milliseconds(Long milliseconds) The total length of milliseconds to wait on the condition to be satisfied
WaitBuilder	milliseconds(String milliseconds) The total length of milliseconds to wait on the condition to be satisfied
WaitBuilder	ms(Long milliseconds) Deprecated. in favor of milliseconds(Long)
WaitBuilder	ms(String milliseconds) Deprecated. in favor of milliseconds(String)
WaitBuilder	seconds(Long seconds) The total length of seconds to wait on the condition to be satisfied
WaitBuilder	seconds(String seconds) The total length of seconds to wait on the condition to be satisfied

Methods inherited from class com.consol.citrus.dsl.builder.AbstractTestContainerBuilder

actions, getActions

Methods inherited from class com.consol.citrus.dsl.builder.AbstractTestActionBuilder

actor, build, description, 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.dsl.builder.TestActionBuilder

build

Constructor Detail

WaitBuilder

public WaitBuilder(TestDesigner designer,
                   Wait action,
                   Stack<AbstractActionContainer> containers)

Constructor using designer and action field.

Parameters:

designer - The designer to execute this action in

action - The container to add this action to

WaitBuilder

public WaitBuilder(TestRunner runner,
                   Wait action)

Constructor using runner and action field.

Parameters:

runner - The test runner to execute this action in

action - The container to add this action to

Method Detail

condition

public Wait condition(Condition condition)

Condition to wait for during execution.

Parameters:

condition - The condition to add to the wait action

Returns:

The wait action

http

@Deprecated
public WaitHttpConditionBuilder http(String url)

Deprecated. in favor of http()

The HTTP condition to wait for during execution.

http

public WaitHttpConditionBuilder http()

The HTTP condition to wait for during execution.

Returns:

A WaitHttpConditionBuilder for further configuration

message

@Deprecated
public WaitConditionBuilder message(String name)

Deprecated. in favor of message()

The message condition to wait for during execution.

Parameters:

name - the message to wait on

Returns:

WaitConditionBuilder for further configuration

message

public WaitMessageConditionBuilder message()

The message condition to wait for during execution.

Returns:

A WaitMessageConditionBuilder for further configuration

execution

public WaitActionConditionBuilder execution()

The test action condition to wait for during execution.

Returns:

A WaitActionConditionBuilder for further configuration

file

@Deprecated
public WaitFileConditionBuilder file(String filePath)

Deprecated. in favor of file()

The file condition to wait for during execution.

file

@Deprecated
public WaitFileConditionBuilder file(File file)

Deprecated. in favor of file()

The file condition to wait for during execution.

file

public WaitFileConditionBuilder file()

The file condition to wait for during execution.

Returns:

A WaitFileConditionBuilder for further configuration

seconds

public WaitBuilder seconds(String seconds)

The total length of seconds to wait on the condition to be satisfied

Parameters:

seconds - The seconds to wait

Returns:

The altered WaitBuilder

seconds

public WaitBuilder seconds(Long seconds)

The total length of seconds to wait on the condition to be satisfied

Parameters:

seconds - The seconds to wait

Returns:

The altered WaitBuilder

ms

@Deprecated
public WaitBuilder ms(String milliseconds)

Deprecated. in favor of milliseconds(String)

The total length of milliseconds to wait on the condition to be satisfied

Parameters:

milliseconds - The milliseconds to wait

Returns:

The altered WaitBuilder

ms

@Deprecated
public WaitBuilder ms(Long milliseconds)

Deprecated. in favor of milliseconds(Long)

The total length of milliseconds to wait on the condition to be satisfied

Parameters:

milliseconds - The milliseconds to wait

Returns:

The altered WaitBuilder

milliseconds

public WaitBuilder milliseconds(String milliseconds)

The total length of milliseconds to wait on the condition to be satisfied

Parameters:

milliseconds - The milliseconds to wait

Returns:

The altered WaitBuilder

milliseconds

public WaitBuilder milliseconds(Long milliseconds)

The total length of milliseconds to wait on the condition to be satisfied

Parameters:

milliseconds - The milliseconds to wait

Returns:

The altered WaitBuilder

interval

public WaitBuilder interval(String interval)

The interval in seconds to use between each test of the condition

Parameters:

interval - The interval to use

Returns:

The altered WaitBuilder

interval

public WaitBuilder interval(Long interval)

The interval in seconds to use between each test of the condition

Parameters:

interval - The interval to use

Returns:

The altered WaitBuilder

buildAndRun

public Wait buildAndRun()

Finishes action build process.

Returns:

The Wait action to execute