Package com.consol.citrus.container

Class Timer.Builder

java.lang.Object

com.consol.citrus.AbstractTestActionBuilder<T,S>

com.consol.citrus.AbstractTestContainerBuilder<Timer,Timer.Builder>

com.consol.citrus.container.Timer.Builder

All Implemented Interfaces:

com.consol.citrus.TestActionBuilder<Timer>, com.consol.citrus.TestActionContainerBuilder<Timer,Timer.Builder>

Enclosing class:

Timer

public static class Timer.Builder
extends AbstractTestContainerBuilder<Timer,Timer.Builder>

Action builder.

Nested Class Summary

Nested classes/interfaces inherited from interface com.consol.citrus.TestActionBuilder

com.consol.citrus.TestActionBuilder.DelegatingTestActionBuilder<T extends com.consol.citrus.TestAction>

Field Summary

Fields inherited from class com.consol.citrus.AbstractTestContainerBuilder

actions

Fields inherited from class com.consol.citrus.AbstractTestActionBuilder

self

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Timer.Builder	delay(long delay)	Initial delay in milliseconds before first timer event should fire.
Timer	doBuild()	Builds the container.
Timer.Builder	fork(boolean fork)	Fork the timer so that other actions can run in parallel to the nested timer actions
Timer.Builder	interval(long interval)	Interval in milliseconds between each timer.
Timer.Builder	repeatCount(int repeatCount)	The maximum number of times the timer event is fired.
static Timer.Builder	timer()	Fluent API action building entry method used in Java DSL.
Timer.Builder	timerId(String timerId)	Set the timer's id.

Methods inherited from class com.consol.citrus.AbstractTestContainerBuilder

actions, actions, build, container, getActions

Methods inherited from class com.consol.citrus.AbstractTestActionBuilder

actor, description, getActor, getDescription, getName, name

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

timer

public static Timer.Builder timer()

Fluent API action building entry method used in Java DSL.

Returns:

delay

public Timer.Builder delay(long delay)

Initial delay in milliseconds before first timer event should fire.

Parameters:

delay -

interval

public Timer.Builder 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 Timer.Builder 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 Timer.Builder fork(boolean fork)

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

Parameters:

fork -

timerId

public Timer.Builder 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

doBuild

public Timer doBuild()

Description copied from class: AbstractTestContainerBuilder

Builds the container.

Specified by:

doBuild in class AbstractTestContainerBuilder<Timer,Timer.Builder>

Returns: