com.consol.citrus.dsl.builder

Class TimerBuilder

java.lang.Object

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

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

com.consol.citrus.dsl.builder.TimerBuilder

All Implemented Interfaces:

TestActionBuilder<Timer>, TestActionContainerBuilder<Timer>, TestAction

public class TimerBuilder
extends AbstractTestContainerBuilder<Timer>

Since:

2.5

Author:

Martin Maher

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
TimerBuilder(TestDesigner designer)
TimerBuilder(TestDesigner designer, Timer container)
TimerBuilder(TestRunner runner)
TimerBuilder(TestRunner runner, Timer container)

Method Summary

Modifier and Type	Method and Description
TimerBuilder	delay(long delay) Initial delay in milliseconds before first timer event should fire.
TimerBuilder	fork(boolean fork) Fork the timer so that other actions can run in parallel to the nested timer actions
TimerBuilder	interval(long interval) Interval in milliseconds between each timer.
TimerBuilder	repeatCount(int repeatCount) The maximum number of times the timer event is fired.
TimerBuilder	timerId(String timerId) Set the timer's id.

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

actions, getActions

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

build, description, execute, getActor, getDescription, getName, isDisabled, 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

TimerBuilder

public TimerBuilder(TestRunner runner,
                    Timer container)

TimerBuilder

public TimerBuilder(TestRunner runner)

TimerBuilder

public TimerBuilder(TestDesigner designer,
                    Timer container)

TimerBuilder

public TimerBuilder(TestDesigner designer)

Method Detail

delay

public TimerBuilder delay(long delay)

Initial delay in milliseconds before first timer event should fire.

Parameters:

delay -

interval

public TimerBuilder interval(long interval)

Interval in milliseconds between each timer. As soon as the interval has elapsed the next timer event is fired.

Parameters:

interval -

repeatCount

public TimerBuilder repeatCount(int repeatCount)

The maximum number of times the timer event is fired. Once this maximum number has been reached the timer is stopped

Parameters:

repeatCount -

fork

public TimerBuilder fork(boolean fork)

Fork the timer so that other actions can run in parallel to the nested timer actions

Parameters:

fork -

timerId

public TimerBuilder timerId(String timerId)

Set the timer's id. This is useful when referencing the timer from other test actions like stop-timer

Parameters:

timerId - a unique timer id within the test context