final class CommandHandlerBuilder[Command, Event, State] extends AnyRef
- Alphabetic
- By Inheritance
- CommandHandlerBuilder
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new CommandHandlerBuilder()
Value Members
- def build(): CommandHandler[Command, Event, State]
-
def
forAnyState(): CommandHandlerBuilderByState[Command, Event, State, State]
The handlers defined by this builder are used for any state.
The handlers defined by this builder are used for any state. This variant is particular useful for models that have a single type (ie: no class hierarchy).
Note: command handlers are matched in the order they are added. Once a matching is found, it's selected for handling the command and no further lookup is done. Therefore you must make sure that their matching conditions don't overlap, otherwise you risk to 'shadow' part of your command handlers. Extra care should be taken when using forAnyState as it will match any state. Any command handler define after it will never be reached.
- returns
A new, mutable, CommandHandlerBuilderByState
-
def
forNonNullState(): CommandHandlerBuilderByState[Command, Event, State, State]
The handlers defined by this builder are used for any not
null
state.The handlers defined by this builder are used for any not
null
state.Note: command handlers are matched in the order they are added. Once a matching is found, it's selected for handling the command and no further lookup is done. Therefore you must make sure that their matching conditions don't overlap, otherwise you risk to 'shadow' part of your command handlers.
- returns
A new, mutable, CommandHandlerBuilderByState
-
def
forNullState(): CommandHandlerBuilderByState[Command, Event, State, State]
The handlers defined by this builder are used when the state is
null
.The handlers defined by this builder are used when the state is
null
. This variant is particular useful when the empty state of your model is defined asnull
.Note: command handlers are matched in the order they are added. Once a matching is found, it's selected for handling the command and no further lookup is done. Therefore you must make sure that their matching conditions don't overlap, otherwise you risk to 'shadow' part of your command handlers.
- returns
A new, mutable, CommandHandlerBuilderByState
-
def
forState[S <: State](stateClass: Class[S], statePredicate: Predicate[S]): CommandHandlerBuilderByState[Command, Event, S, State]
Use this method to define command handlers that are selected when the passed predicate holds true for a given subtype of your model.
Use this method to define command handlers that are selected when the passed predicate holds true for a given subtype of your model. Useful when the model is defined as class hierarchy.
Note: command handlers are matched in the order they are added. Once a matching is found, it's selected for handling the command and no further lookup is done. Therefore you must make sure that their matching conditions don't overlap, otherwise you risk to 'shadow' part of your command handlers.
- stateClass
The handlers defined by this builder are used when the state is an instance of the
stateClass
- statePredicate
The handlers defined by this builder are used when the
statePredicate
istrue
- returns
A new, mutable, CommandHandlerBuilderByState
-
def
forState(statePredicate: Predicate[State]): CommandHandlerBuilderByState[Command, Event, State, State]
Use this method to define command handlers that are selected when the passed predicate holds true.
Use this method to define command handlers that are selected when the passed predicate holds true.
Note: command handlers are matched in the order they are added. Once a matching is found, it's selected for handling the command and no further lookup is done. Therefore you must make sure that their matching conditions don't overlap, otherwise you risk to 'shadow' part of your command handlers.
- statePredicate
The handlers defined by this builder are used when the
statePredicate
istrue
- returns
A new, mutable, CommandHandlerBuilderByState
-
def
forStateType[S <: State](stateClass: Class[S]): CommandHandlerBuilderByState[Command, Event, S, State]
Use this method to define command handlers for a given subtype of your model.
Use this method to define command handlers for a given subtype of your model. Useful when the model is defined as class hierarchy.
Note: command handlers are matched in the order they are added. Once a matching is found, it's selected for handling the command and no further lookup is done. Therefore you must make sure that their matching conditions don't overlap, otherwise you risk to 'shadow' part of your command handlers.
- stateClass
The handlers defined by this builder are used when the state is an instance of the
stateClass
.- returns
A new, mutable, CommandHandlerBuilderByState