Package org.citrusframework.container

Class Timer.Builder

java.lang.Object
org.citrusframework.AbstractTestActionBuilder<T,S>
org.citrusframework.AbstractTestContainerBuilder<Timer,Timer.Builder>
org.citrusframework.container.Timer.Builder
All Implemented Interfaces:
ReferenceResolverAware, TestActionBuilder<Timer>, TestActionContainerBuilder<Timer,Timer.Builder>
Enclosing class:
Timer
public static class Timer.Builder extends AbstractTestContainerBuilder<Timer,Timer.Builder>
Action builder.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • 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 -

    • id

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

    • 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: