org.requirementsascode

Class AbstractActor

java.lang.Object

org.requirementsascode.AbstractActor

Direct Known Subclasses:

Actor

public abstract class AbstractActor
extends java.lang.Object

An actor can be anything with a behavior. It can be the system/service you're developing, or a role that an external user plays. Actors can be senders and receivers of messages to other actors. Actors enable to distinguish user rights: only an actor that is connected to a particular step is allowed to cause a system reaction for that step.

Constructor Summary

Constructors

Constructor and Description
AbstractActor() Creates an actor with a name equal to the current class' simple name.
AbstractActor(java.lang.String name) Creates an actor with the specified name.

Method Summary

Modifier and Type	Method and Description
abstract Model	behavior() Override this method to provide the model for the actor's behavior.
protected void	createRunnerWithBehaviorIfPresent()
boolean	equals(java.lang.Object obj)
ModelRunner	getModelRunner() Call this method from a subclass to customize the way the actor runs the behavior.
java.lang.String	getName() Returns the name of the actor.
java.util.List<Step>	getStepsOf(UseCase useCase) Returns the steps this actor is connected with, for the specified use case.
java.util.Set<UseCase>	getUseCases() Returns the use cases this actor is associated with, as an external user.
int	hashCode()
<T,U> java.util.Optional<U>	reactTo(java.lang.Object message, AbstractActor callingActor) Same as reactTo(Object), but with the specified actor as the calling user's role.
<T,U> java.util.Optional<U>	reactTo(T message) Call this method to provide a message (i.e. command or event object) to the actor.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractActor

public AbstractActor()

Creates an actor with a name equal to the current class' simple name.

AbstractActor

public AbstractActor(java.lang.String name)

Creates an actor with the specified name.

Parameters:

name - the name of the actor

Method Detail

createRunnerWithBehaviorIfPresent

protected void createRunnerWithBehaviorIfPresent()

getName

public java.lang.String getName()

Returns the name of the actor.

Returns:

the name

getUseCases

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

Returns the use cases this actor is associated with, as an external user.

The actor is associated to a use case if it is connected to at least one of its steps.

Note: don't confuse this with the use cases that the actor owns as part of its behavior.

Returns:

the use cases the actor is associated with

getStepsOf

public java.util.List<Step> getStepsOf(UseCase useCase)

Returns the steps this actor is connected with, for the specified use case.

Note: don't confuse this with the steps that the actor owns as part of its behavior.

Parameters:

useCase - the use case to query for steps the actor is connected with

Returns:

the steps the actor is connected with

reactTo

public <T,U> java.util.Optional<U> reactTo(T message)

Call this method to provide a message (i.e. command or event object) to the actor.

The actor will then check which steps can react. If a single step can react, the actor will call the message handler with it. If no step can react, the actor will either call the handler defined with ModelRunner.handleUnhandledWith(Consumer) on the actor's model runner, or if no such handler exists, consume the message silently. If more than one step can react, the actor will throw an exception.

After that, the actor will trigger "autonomous system reactions" that don't have a message class. Note that if you provide a collection as the first and only argument, this will be flattened to the objects in the collection, and for each object reactTo(Object) is called.

Type Parameters:

T - the type of message

U - the return type that you as the user expects.

Parameters:

message - the message object

Returns:

the event that was published (latest) if the system reacted, or an empty Optional.

Throws:

MoreThanOneStepCanReact - when more than one step can react

InfiniteRepetition - when a step has an always true condition, or there is an infinite loop.

java.lang.ClassCastException - when type of the returned instance isn't U

See Also:

getModelRunner(), ModelRunner.handleUnhandledWith(Consumer), ModelRunner.reactTo(Object)

reactTo

public <T,U> java.util.Optional<U> reactTo(java.lang.Object message,
                                           AbstractActor callingActor)

Same as reactTo(Object), but with the specified actor as the calling user's role.

Type Parameters:

T - the type of message

U - the return type that you as the user expects.

Parameters:

message - the message object

callingActor - the actor as which to call this actor.

Returns:

the event that was published (latest) if the system reacted, or an empty Optional.

behavior

public abstract Model behavior()

Override this method to provide the model for the actor's behavior.

Returns:

the behavior

getModelRunner

public ModelRunner getModelRunner()

Call this method from a subclass to customize the way the actor runs the behavior.

Returns:

the single model runner encapsulated by this actor

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object