org.requirementsascode

Class Model

java.lang.Object

org.requirementsascode.Model

public class Model
extends java.lang.Object

A model is a container for events/commands and the system reactions that handle them. Either implicitly or explicitly, the model contains use cases and their contained steps. Each step contains the event/command and the system reaction, the condition under which it is executed and the actors it is associated with. A model is used to configure a ModelRunner.

Method Summary

Modifier and Type	Method and Description
static ModelBuilder	builder() The only way to build a model and its parts is to use the builder returned by this method.
AbstractActor	findActor(java.lang.String actorName) Finds the actor with the specified name, contained in this model.
UseCase	findUseCase(java.lang.String useCaseName) Finds the use case with the specified name, contained in this model.
java.util.Collection<AbstractActor>	getActors() Returns the actors contained in this model.
java.util.Collection<Step>	getSteps() Returns the steps of use cases contained in this model.
AbstractActor	getSystemActor() Returns the actor representing the system.
java.util.Collection<UseCase>	getUseCases() Returns the use cases contained in this model.
AbstractActor	getUserActor() Returns the actor representing the default user.
boolean	hasActor(java.lang.String actorName) Checks whether this model contains the specified actor.
boolean	hasUseCase(java.lang.String useCaseName) Checks whether this model contains the specified use case.
UseCase	newUseCase(java.lang.String useCaseName)

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ModelBuilder builder()

The only way to build a model and its parts is to use the builder returned by this method.

Returns:

the builder.

hasActor

public boolean hasActor(java.lang.String actorName)

Checks whether this model contains the specified actor.

Parameters:

actorName - the name of the actor whose existence to check

Returns:

true if this model contains the specified actor, false otherwise

hasUseCase

public boolean hasUseCase(java.lang.String useCaseName)

Checks whether this model contains the specified use case.

Parameters:

useCaseName - the name of the use case whose existence to check

Returns:

true if this model contains the specified use case, false otherwise

newUseCase

public UseCase newUseCase(java.lang.String useCaseName)

findActor

public AbstractActor findActor(java.lang.String actorName)

Finds the actor with the specified name, contained in this model.

Parameters:

actorName - the name of the actor to look for

Returns:

the actor if found, or else an empty optional

Throws:

NoSuchElementInModel - if no actor with the specified actorName is found in the model

findUseCase

public UseCase findUseCase(java.lang.String useCaseName)

Finds the use case with the specified name, contained in this model.

Parameters:

useCaseName - the name of the use case to look for

Returns:

the use case if found, or else an empty optional

Throws:

NoSuchElementInModel - if no use case with the specified useCaseName is found in the model

getActors

public java.util.Collection<AbstractActor> getActors()

Returns the actors contained in this model.

Returns:

the actors

getUseCases

public java.util.Collection<UseCase> getUseCases()

Returns the use cases contained in this model.

Returns:

the use cases

getSteps

public java.util.Collection<Step> getSteps()

Returns the steps of use cases contained in this model.

Returns:

the use steps

getUserActor

public AbstractActor getUserActor()

Returns the actor representing the default user.

Returns:

the user actor

getSystemActor

public AbstractActor getSystemActor()

Returns the actor representing the system.

Returns:

the user actor