org.requirementsascode.builder

Class UseCasePart

java.lang.Object

org.requirementsascode.builder.UseCasePart

public class UseCasePart
extends java.lang.Object

Part used by the ModelBuilder to build a Model.

See Also:

UseCase

Method Summary

Modifier and Type	Method and Description
UseCasePart	as(AbstractActor defaultActor) Define a default actor that will be used for each step of the use case, unless it is overwritten by specific actors for the steps (with as).
FlowPart	basicFlow() Start the "happy day scenario" where all is fine and dandy.
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.
FlowPart	flow(java.lang.String flowName) Start a flow with the specified name.
<T> FlowlessUserPart<T>	on(java.lang.Class<T> eventOrExceptionClass) Defines the type of events or exceptions that will cause a system reaction.
FlowlessStepPart	step(java.lang.String stepName) Creates a named step.
<T> FlowlessUserPart<T>	user(java.lang.Class<T> 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

basicFlow

public FlowPart basicFlow()

Start the "happy day scenario" where all is fine and dandy.

Returns:

the flow part to create the steps of the basic flow.

flow

public FlowPart flow(java.lang.String flowName)

Start a flow with the specified name.

Parameters:

flowName - the name of the flow.

Returns:

the flow part to create the steps of the flow.

as

public UseCasePart as(AbstractActor defaultActor)

Define a default actor that will be used for each step of the use case, unless it is overwritten by specific actors for the steps (with as).

Parameters:

defaultActor - the actor to use as a default for the use case's steps

Returns:

this use case part

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

T - the type of the class

Parameters:

commandClass - the class of commands the system reacts to

Returns:

the created user part

on

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

Defines the type of events 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:

T - the type of the class

Parameters:

eventOrExceptionClass - the class of events the system reacts to

Returns:

the created user part

build

public Model build()

Returns the model that has been built.

Returns:

the model