org.requirementsascode.builder

Class FlowPart

java.lang.Object

org.requirementsascode.builder.FlowPart

public class FlowPart
extends java.lang.Object

Part used by the ModelBuilder to build a Model.

See Also:

Flow

Method Summary

Modifier and Type	Method and Description
FlowPositionPart	after(java.lang.String stepName) Starts the flow after the specified step has been run, in this flow's use case.
FlowPositionPart	anytime() Starts the flow after any step that has been run, or at the beginning.
FlowConditionPart	condition(Condition condition) Constrains the flow's condition: only if the specified condition is true, the flow is started.
FlowPositionPart	insteadOf(java.lang.String stepName) Starts the flow as an alternative to the specified step, in this flow's use case.
StepPart	step(java.lang.String stepName) Creates the first step of this flow, without specifying position or condition.

Methods inherited from class java.lang.Object

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

Method Detail

after

public FlowPositionPart after(java.lang.String stepName)

Starts the flow after the specified step has been run, in this flow's use case. Note: You should use after to handle exceptions that occurred in the specified step.

Parameters:

stepName - the name of the step to start the flow after

Returns:

the flow position part, to ease creation of the condition and the first step of the flow

Throws:

NoSuchElementInModel - if the specified step is not found in a flow of this use case

step

public StepPart step(java.lang.String stepName)

Creates the first step of this flow, without specifying position or condition. It can be interrupted by any other flow that has an explicit position and/or condition. It can be run when no other step has been run before.

Parameters:

stepName - the name of the step to be created

Returns:

the newly created step part, to ease creation of further steps

Throws:

ElementAlreadyInModel - if a step with the specified name already exists in the use case

insteadOf

public FlowPositionPart insteadOf(java.lang.String stepName)

Starts the flow as an alternative to the specified step, in this flow's use case.

Parameters:

stepName - the name of the specified step

Returns:

the flow position part, to ease creation of the condition and the first step of the flow

Throws:

NoSuchElementInModel - if the specified step is not found in this flow's use case

anytime

public FlowPositionPart anytime()

Starts the flow after any step that has been run, or at the beginning.

Returns:

the flow position part, to ease creation of the condition and the first step of the flow

condition

public FlowConditionPart condition(Condition condition)

Constrains the flow's condition: only if the specified condition is true, the flow is started.

Parameters:

condition - the condition that constrains when the flow is started

Returns:

the condition part, to ease creation of the first step of the flow