org.requirementsascode.builder

Class StepSystemPart<T>

java.lang.Object

org.requirementsascode.builder.StepSystemPart<T>

public class StepSystemPart<T>
extends java.lang.Object

Part used by the ModelBuilder to build a Model.

Method Summary

Modifier and Type	Method and Description
Model	build() Returns the model built so far.
FlowPart	flow(java.lang.String flowName) Creates a new flow in the current use case.
StepSystemPart<T>	reactWhile(Condition reactWhileCondition) React to this step's message as long as the condition is fulfilled.
StepPart	step(java.lang.String stepName) Creates a new step in this flow, with the specified name, that follows the current step in sequence.
StepToPart<T>	to(AbstractActor recipient) Specifies the recipient of the message.
UseCasePart	useCase(java.lang.String useCaseName) Creates a new use case in the current model.

Methods inherited from class java.lang.Object

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

Method Detail

step

public StepPart step(java.lang.String stepName)

Creates a new step in this flow, with the specified name, that follows the current step in sequence.

Parameters:

stepName - the name of the step to be created

Returns:

the newly created step

Throws:

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

flow

public FlowPart flow(java.lang.String flowName)

Creates a new flow in the current use case.

Parameters:

flowName - the name of the flow to be created.

Returns:

the newly created flow part

Throws:

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

useCase

public UseCasePart useCase(java.lang.String useCaseName)

Creates a new use case in the current model.

Parameters:

useCaseName - the name of the use case to be created.

Returns:

the newly created use case part

Throws:

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

reactWhile

public StepSystemPart<T> reactWhile(Condition reactWhileCondition)

React to this step's message as long as the condition is fulfilled.

Even when the condition is fulfilled, the flow can advance given that the message of the next step is received.

Note that if the condition is not fulfilled after the previous step has been performed, the step will not react at all.

Parameters:

reactWhileCondition - the condition to check

Returns:

the system part

to

public StepToPart<T> to(AbstractActor recipient)

Specifies the recipient of the message.

Parameters:

recipient - the recipient of this message

Returns:

the created part

build

public Model build()

Returns the model built so far.

Returns:

the model