Class CommandHandlerBuilder<Command,State>
- java.lang.Object
-
- akka.persistence.typed.state.javadsl.CommandHandlerBuilder<Command,State>
-
public final class CommandHandlerBuilder<Command,State> extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description CommandHandlerBuilder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CommandHandler<Command,State>
build()
static <Command,State>
CommandHandlerBuilder<Command,State>builder()
CommandHandlerBuilderByState<Command,State,State>
forAnyState()
The handlers defined by this builder are used for any state.CommandHandlerBuilderByState<Command,State,State>
forNonNullState()
The handlers defined by this builder are used for any notnull
state.CommandHandlerBuilderByState<Command,State,State>
forNullState()
The handlers defined by this builder are used when the state isnull
.<S extends State>
CommandHandlerBuilderByState<Command,S,State>forState(java.lang.Class<S> stateClass, java.util.function.Predicate<S> statePredicate)
Use this method to define command handlers that are selected when the passed predicate holds true for a given subtype of your model.CommandHandlerBuilderByState<Command,State,State>
forState(java.util.function.Predicate<State> statePredicate)
Use this method to define command handlers that are selected when the passed predicate holds true.<S extends State>
CommandHandlerBuilderByState<Command,S,State>forStateType(java.lang.Class<S> stateClass)
Use this method to define command handlers for a given subtype of your model.
-
-
-
Method Detail
-
builder
public static <Command,State> CommandHandlerBuilder<Command,State> builder()
-
forState
public CommandHandlerBuilderByState<Command,State,State> forState(java.util.function.Predicate<State> statePredicate)
Use this method to define command handlers that are selected when the passed predicate holds true.Note: command handlers are selected 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.
- Parameters:
statePredicate
- The handlers defined by this builder are used when thestatePredicate
istrue
- Returns:
- A new, mutable, CommandHandlerBuilderByState
-
forState
public <S extends State> CommandHandlerBuilderByState<Command,S,State> forState(java.lang.Class<S> stateClass, java.util.function.Predicate<S> statePredicate)
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 selected 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.
- Parameters:
stateClass
- The handlers defined by this builder are used when the state is an instance of thestateClass
statePredicate
- The handlers defined by this builder are used when thestatePredicate
istrue
- Returns:
- A new, mutable, CommandHandlerBuilderByState
-
forStateType
public <S extends State> CommandHandlerBuilderByState<Command,S,State> forStateType(java.lang.Class<S> stateClass)
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 selected 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.
- Parameters:
stateClass
- The handlers defined by this builder are used when the state is an instance of thestateClass
.- Returns:
- A new, mutable, CommandHandlerBuilderByState
-
forNullState
public CommandHandlerBuilderByState<Command,State,State> forNullState()
The handlers defined by this builder are used when the state isnull
. This variant is particular useful when the empty state of your model is defined asnull
.Note: command handlers are selected 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
-
forNonNullState
public CommandHandlerBuilderByState<Command,State,State> forNonNullState()
The handlers defined by this builder are used for any notnull
state.Note: command handlers are selected 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
-
forAnyState
public CommandHandlerBuilderByState<Command,State,State> forAnyState()
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 selected 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
-
build
public CommandHandler<Command,State> build()
-
-