org.requirementsascode.builder

Class FlowlessSystemPart<T>

java.lang.Object

org.requirementsascode.builder.FlowlessSystemPart<T>

public class FlowlessSystemPart<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 that has been built.
FlowlessConditionPart	condition(Condition condition) Constrains the condition for triggering a system reaction: only if the specified condition is true, a system reaction can be triggered.
<U> FlowlessUserPart<U>	on(java.lang.Class<U> messageClass) Defines the type of messages or exceptions that will cause a system reaction.
FlowlessStepPart	step(java.lang.String stepName) Creates a named step.
FlowlessToPart	to(AbstractActor recipient) Specifies the recipient of the message.
UseCasePart	useCase(java.lang.String useCaseName) Creates a new use case in the current model, and returns a part for building its details.
<U> FlowlessUserPart<U>	user(java.lang.Class<U> commandClass) Defines the type of commands that will cause a system reaction.

Methods inherited from class java.lang.Object

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

Method Detail

condition

public FlowlessConditionPart condition(Condition condition)

Constrains the condition for triggering a system reaction: only if the specified condition is true, a system reaction can be triggered.

Parameters:

condition - the condition that constrains when the system reaction is triggered

Returns:

the created condition part

step

public FlowlessStepPart step(java.lang.String stepName)

Creates a named step.

Parameters:

stepName - the name of the created step

Returns:

the created step part

user

public <U> FlowlessUserPart<U> user(java.lang.Class<U> commandClass)

Defines the type of commands that will cause a system reaction.

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:

U - the type of the class

Parameters:

commandClass - the class of commands the system reacts to

Returns:

the created user part

on

public <U> FlowlessUserPart<U> on(java.lang.Class<U> messageClass)

Defines the type of messages or exceptions that will cause a system reaction.

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:

U - the type of the class

Parameters:

messageClass - the class of messages the system reacts to

Returns:

the created user part

useCase

public UseCasePart useCase(java.lang.String useCaseName)

Creates a new use case in the current model, and returns a part for building its details. If a use case with the specified name already exists, returns a part for the existing use case.

Parameters:

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

Returns:

the created / found use case's part.

to

public FlowlessToPart 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 that has been built.

Returns:

the model