org.requirementsascode.builder

Class ModelBuilder

java.lang.Object

org.requirementsascode.builder.ModelBuilder

public class ModelBuilder
extends java.lang.Object

Class that builds a Model, in a fluent way.

Constructor Summary

Constructors

Constructor and Description
ModelBuilder(Model model)

Method Summary

Modifier and Type	Method and Description
Model	build() Returns the model built so far.
FlowlessConditionPart	condition(Condition condition) Only if the specified condition is true, the message is handled.
<T> FlowlessUserPart<T>	on(java.lang.Class<T> messageClass) Creates a handler for messages or exceptions of the specified type.
FlowlessStepPart	step(java.lang.String stepName) Creates a named step.
UseCasePart	useCase(java.lang.String useCaseName) Creates a new use case in the current model, and returns a part for building its details.
<T> FlowlessUserPart<T>	user(java.lang.Class<T> commandClass) Creates a handler for commands of the specified type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelBuilder

public ModelBuilder(Model model)

Method Detail

condition

public FlowlessConditionPart condition(Condition condition)

Only if the specified condition is true, the message is handled.

Parameters:

condition - the condition that constrains when the message is handled

Returns:

a part of the builder used to define the message class

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 <T> FlowlessUserPart<T> user(java.lang.Class<T> commandClass)

Creates a handler for commands of the specified type.

Internally, a default use case ("Handles messages") is created in the model.

Type Parameters:

T - the type of command

Parameters:

commandClass - the specified command class

Returns:

a part of the builder used to create the message handler (the "system reaction")

on

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

Creates a handler for messages or exceptions of the specified type.

Internally, a default use case ("Handles messages") is created in the model.

Type Parameters:

T - the type of messages

Parameters:

messageClass - the specified type of messages

Returns:

a part of the builder used to create the message handler (the "system reaction")

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.

build

public Model build()

Returns the model built so far.

Returns:

the model