org.requirementsascode.builder

Class StepPart

java.lang.Object

org.requirementsascode.builder.StepPart

public class StepPart
extends java.lang.Object

Part used by the ModelBuilder to build a Model.

See Also:

Step

Method Summary

Modifier and Type	Method and Description
StepAsPart	as(AbstractActor... actors) Defines which actors (i.e. user groups) can cause the system to react to the message of this step.
UseCasePart	continuesAfter(java.lang.String stepName) Makes the model runner continue after the specified step.
UseCasePart	continuesAt(java.lang.String stepName) Makes the model runner continue at the specified step.
UseCasePart	continuesWithoutAlternativeAt(java.lang.String stepName) Makes the model runner continue at the specified step.
<T> StepUserPart<T>	on(java.lang.Class<T> eventOrExceptionClass) Defines the type of system event objects or exceptions that this step handles.
StepSystemPart<ModelRunner>	system(java.lang.Runnable systemReaction) Defines an "autonomous system reaction", meaning the system will react without needing a message provided via ModelRunner.reactTo(Object).
StepSystemPart<ModelRunner>	systemPublish(java.util.function.Supplier<?> systemReaction) Defines an "autonomous system reaction", meaning the system will react without needing a message provided via ModelRunner.reactTo(Object).
<T> StepUserPart<T>	user(java.lang.Class<T> commandClass) Defines the type of user command objects that this step accepts.

Methods inherited from class java.lang.Object

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

Method Detail

as

public StepAsPart as(AbstractActor... actors)

Defines which actors (i.e. user groups) can cause the system to react to the message of this step.

Parameters:

actors - the actors that define the user groups

Returns:

the created as part of this step

user

public <T> StepUserPart<T> user(java.lang.Class<T> commandClass)

Defines the type of user command objects that this step accepts. Commands of this type can cause a system reaction.

Given that the step's condition is true, and the actor is right, the system reacts to objects that are instances of the specified class or instances of any direct or indirect subclass of the specified class.

Type Parameters:

T - the type of the class

Parameters:

commandClass - the class of commands the system reacts to in this step

Returns:

the created user part of this step

on

public <T> StepUserPart<T> on(java.lang.Class<T> eventOrExceptionClass)

Defines the type of system event objects or exceptions that this step handles. Events of the specified type can cause a system reaction.

Given that the step's condition is true, and the actor is right, the system reacts to objects that are instances of the specified class or instances of any direct or indirect subclass of the specified class.

Type Parameters:

T - the type of the class

Parameters:

eventOrExceptionClass - the class of events the system reacts to in this step

Returns:

the created user part of this step

system

public StepSystemPart<ModelRunner> system(java.lang.Runnable systemReaction)

Defines an "autonomous system reaction", meaning the system will react without needing a message provided via ModelRunner.reactTo(Object).

Parameters:

systemReaction - the autonomous system reaction

Returns:

the created system part of this step

systemPublish

public StepSystemPart<ModelRunner> systemPublish(java.util.function.Supplier<?> systemReaction)

Defines an "autonomous system reaction", meaning the system will react without needing a message provided via ModelRunner.reactTo(Object). After executing the system reaction, the runner will publish the returned event.

Parameters:

systemReaction - the autonomous system reaction, that returns a single event to be published.

Returns:

the created system part of this step

continuesAfter

public UseCasePart continuesAfter(java.lang.String stepName)

Makes the model runner continue after the specified step.

Parameters:

stepName - name of the step to continue after, in this use case.

Returns:

the use case part this step belongs to, to ease creation of further flows

Throws:

NoSuchElementInModel - if no step with the specified stepName is found in the current use case

continuesAt

public UseCasePart continuesAt(java.lang.String stepName)

Makes the model runner continue at the specified step. If there are alternative flows starting at the specified step, one may be entered if its condition is enabled.

Parameters:

stepName - name of the step to continue at, in this use case.

Returns:

the use case part this step belongs to, to ease creation of further flows

Throws:

NoSuchElementInModel - if no step with the specified stepName is found in the current use case

continuesWithoutAlternativeAt

public UseCasePart continuesWithoutAlternativeAt(java.lang.String stepName)

Makes the model runner continue at the specified step. No alternative flow starting at the specified step is entered, even if its condition is enabled.

Parameters:

stepName - name of the step to continue at, in this use case.

Returns:

the use case part this step belongs to, to ease creation of further flows

Throws:

NoSuchElementInModel - if no step with the specified stepName is found in the current use case