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

java.lang.Object
- com.consol.citrus.actions.AbstractTestAction
- - com.consol.citrus.actions.FailAction

All Implemented Interfaces:

com.consol.citrus.common.Described, com.consol.citrus.common.Named, com.consol.citrus.TestAction, com.consol.citrus.TestActorAware
```
public class FailAction
extends AbstractTestAction
```
Action fails the test explicitly. User can specify a cause message.

Author:

Christoph Deppisch

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class FailAction.Builder
Action builder.

Field Summary
- Fields inherited from class com.consol.citrus.actions.AbstractTestAction
  description

Constructor Summary

Constructors
Constructor Description

FailAction(FailAction.Builder builder)
Default constructor.

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.
`String`	`getMessage()`	Gets the message.

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

- Constructor Detail
  - FailAction
```
public FailAction(FailAction.Builder builder)
```
    Default constructor.
- 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
  - getMessage
```
public String getMessage()
```
    Gets the message.
    
    Returns:
    
    the message