org.requirementsascode

Class StepToBeRun

java.lang.Object

org.requirementsascode.StepToBeRun

public class StepToBeRun
extends java.lang.Object

Use an instance of this class if you want to find out the details about the step to be run in a custom message handler, and to trigger the system reaction.

See Also:

ModelRunner.handleWith(Consumer)

Method Summary

Modifier and Type	Method and Description
java.util.Optional<? extends java.lang.Object>	getCondition() Returns the precondition that needs to be true to trigger the system reaction when run() is called.
java.util.Optional<? extends java.lang.Object>	getMessage() Returns the message object that will be passed to the system reaction when run() is called.
java.lang.String	getStepName() Returns the name of the step whose system reaction is performed when run() is called.
java.lang.Object	getSystemReaction() Returns the system reaction to be executed when run() is called.
void	run() Triggers the system reaction of this step, and publishes the resulting event.

Methods inherited from class java.lang.Object

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

Method Detail

run

public void run()

Triggers the system reaction of this step, and publishes the resulting event.

getStepName

public java.lang.String getStepName()

Returns the name of the step whose system reaction is performed when run() is called.

Returns:

the step name.

getCondition

public java.util.Optional<? extends java.lang.Object> getCondition()

Returns the precondition that needs to be true to trigger the system reaction when run() is called.

Returns:

the condition, or an empty optional when no condition was specified.

getMessage

public java.util.Optional<? extends java.lang.Object> getMessage()

Returns the message object that will be passed to the system reaction when run() is called.

Returns:

the message, or an empty optional when no message was specified.

getSystemReaction

public java.lang.Object getSystemReaction()

Returns the system reaction to be executed when run() is called.

Returns:

the system reaction object, as specified in the model.