Timer (Citrus :: Core :: Base 3.1.0 API)

java.lang.Object
- com.consol.citrus.actions.AbstractTestAction
- - com.consol.citrus.container.AbstractActionContainer
  - - com.consol.citrus.container.Timer

All Implemented Interfaces:

com.consol.citrus.common.Described, com.consol.citrus.common.Named, com.consol.citrus.Completable, com.consol.citrus.container.StopTimer, com.consol.citrus.container.TestActionContainer, com.consol.citrus.TestAction, com.consol.citrus.TestActorAware
```
public class Timer
extends AbstractActionContainer
implements com.consol.citrus.container.StopTimer
```
Since:

2.5

Author:

Martin Maher

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Timer.Builder
Action builder.

Field Summary

Fields
Modifier and Type	Field	Description
`protected static String`	`INDEX_SUFFIX`
`protected boolean`	`timerComplete`
`protected com.consol.citrus.exceptions.CitrusRuntimeException`	`timerException`

Fields inherited from class com.consol.citrus.container.AbstractActionContainer
actions

Fields inherited from class com.consol.citrus.actions.AbstractTestAction
description

Constructor Summary

Constructors
Constructor Description

Timer(Timer.Builder builder)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`doExecute(com.consol.citrus.context.TestContext context)`	Subclasses may add custom execution logic here.
`long`	`getDelay()`
`long`	`getInterval()`
`int`	`getRepeatCount()`
`String`	`getTimerId()`
`boolean`	`isFork()`
`void`	`stopTimer()`

Methods inherited from class com.consol.citrus.container.AbstractActionContainer
addTestAction, addTestAction, addTestActions, addTestActions, getActionCount, getActionIndex, getActions, getActiveAction, getExecutedActions, getTestAction, isDone, setActions, setActiveAction

Methods inherited from class com.consol.citrus.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

Methods inherited from interface com.consol.citrus.TestAction
execute, getActor, getName, isDisabled

Field Detail

INDEX_SUFFIX

protected static final String INDEX_SUFFIX

See Also:: Constant Field Values

timerComplete
```
protected boolean timerComplete
```

timerException

protected com.consol.citrus.exceptions.CitrusRuntimeException timerException

Constructor Detail

Timer

public Timer(Timer.Builder builder)

Method Detail
- doExecute
```
public void doExecute(com.consol.citrus.context.TestContext context)
```
  Description copied from class: AbstractTestAction
  
  Subclasses may add custom execution logic here.
  
  Specified by:
  
  doExecute in class AbstractTestAction
- getTimerId
```
public String getTimerId()
```
- stopTimer
```
public void stopTimer()
```
  Specified by:
  
  stopTimer in interface com.consol.citrus.container.StopTimer
- getInterval
```
public long getInterval()
```
- getDelay
```
public long getDelay()
```
- getRepeatCount
```
public int getRepeatCount()
```
- isFork
```
public boolean isFork()
```