akka.persistence.typed.javadsl
CommandHandlerBuilderByState
Companion object CommandHandlerBuilderByState
final class CommandHandlerBuilderByState[Command, Event, S <: State, State] extends AnyRef
- Alphabetic
- By Inheritance
- CommandHandlerBuilderByState
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from CommandHandlerBuilderByState[Command, Event, S, State] toany2stringadd[CommandHandlerBuilderByState[Command, Event, S, State]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (CommandHandlerBuilderByState[Command, Event, S, State], B)
- Implicit
- This member is added by an implicit conversion from CommandHandlerBuilderByState[Command, Event, S, State] toArrowAssoc[CommandHandlerBuilderByState[Command, Event, S, State]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def build(): CommandHandler[Command, Event, State]
Builds and returns a handler from the appended states.
Builds and returns a handler from the appended states. The returned CommandHandler will throw a scala.MatchError if applied to a command that has no defined case.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def ensuring(cond: (CommandHandlerBuilderByState[Command, Event, S, State]) => Boolean, msg: => Any): CommandHandlerBuilderByState[Command, Event, S, State]
- Implicit
- This member is added by an implicit conversion from CommandHandlerBuilderByState[Command, Event, S, State] toEnsuring[CommandHandlerBuilderByState[Command, Event, S, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (CommandHandlerBuilderByState[Command, Event, S, State]) => Boolean): CommandHandlerBuilderByState[Command, Event, S, State]
- Implicit
- This member is added by an implicit conversion from CommandHandlerBuilderByState[Command, Event, S, State] toEnsuring[CommandHandlerBuilderByState[Command, Event, S, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): CommandHandlerBuilderByState[Command, Event, S, State]
- Implicit
- This member is added by an implicit conversion from CommandHandlerBuilderByState[Command, Event, S, State] toEnsuring[CommandHandlerBuilderByState[Command, Event, S, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): CommandHandlerBuilderByState[Command, Event, S, State]
- Implicit
- This member is added by an implicit conversion from CommandHandlerBuilderByState[Command, Event, S, State] toEnsuring[CommandHandlerBuilderByState[Command, Event, S, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def onAnyCommand(handler: Supplier[Effect[Event, State]]): CommandHandler[Command, Event, State]
Matches any command.
Matches any command.
Use this to declare a command handler that will match any command. This is particular useful when encoding a finite state machine in which the final state is not supposed to handle any new command.
Use this when you just need to return an Effect without using any data from the command or from the 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.
Extra care should be taken when using onAnyCommand as it will match any command. This method builds and returns the command handler since this will not let through any states to subsequent match statements.
- returns
A CommandHandler from the appended states.
- def onAnyCommand(handler: Function[Command, Effect[Event, State]]): CommandHandler[Command, Event, State]
Matches any command.
Matches any command.
Use this to declare a command handler that will match any command. This is particular useful when encoding a finite state machine in which the final state is not supposed to handle any new command.
Use this when you just need to return an Effect without using any data from the 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.
Extra care should be taken when using onAnyCommand as it will match any command. This method builds and returns the command handler since this will not let through any states to subsequent match statements.
- returns
A CommandHandler from the appended states.
- def onAnyCommand(handler: BiFunction[S, Command, Effect[Event, State]]): CommandHandler[Command, Event, State]
Matches any command.
Matches any command.
Use this to declare a command handler that will match any command. This is particular useful when encoding a finite state machine in which the final state is not supposed to handle any new command.
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 onAnyCommand as it will match any command. This method builds and returns the command handler since this will not let through any states to subsequent match statements.
- returns
A CommandHandler from the appended states.
- def onCommand[C <: Command](commandClass: Class[C], handler: Supplier[Effect[Event, State]]): CommandHandlerBuilderByState[Command, Event, S, State]
Matches commands that are of the given
commandClass
or subclass thereof.Matches commands that are of the given
commandClass
or subclass thereof.Use this when you just need to initialize the
State
without using any data from the command.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.
- def onCommand[C <: Command](commandClass: Class[C], handler: Function[C, Effect[Event, State]]): CommandHandlerBuilderByState[Command, Event, S, State]
Matches commands that are of the given
commandClass
or subclass thereof.Matches commands that are of the given
commandClass
or subclass thereof.Use this when the
State
is not needed in thehandler
, otherwise there is an overloaded method that pass the state in aBiFunction
.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.
- def onCommand[C <: Command](commandClass: Class[C], handler: BiFunction[S, C, Effect[Event, State]]): CommandHandlerBuilderByState[Command, Event, S, State]
Matches commands that are of the given
commandClass
or subclass thereofMatches commands that are of the given
commandClass
or subclass thereofNote: 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.
- def onCommand(predicate: Predicate[Command], handler: Function[Command, Effect[Event, State]]): CommandHandlerBuilderByState[Command, Event, S, State]
Matches any command which the given
predicate
returns true for.Matches any command which the given
predicate
returns true for.Use this when the
State
is not needed in thehandler
, otherwise there is an overloaded method that pass the state in aBiFunction
.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.
- def onCommand(predicate: Predicate[Command], handler: BiFunction[S, Command, Effect[Event, State]]): CommandHandlerBuilderByState[Command, Event, S, State]
Matches any command which the given
predicate
returns true for.Matches any command which the given
predicate
returns true for.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.
- def orElse[S2 <: State](other: CommandHandlerBuilderByState[Command, Event, S2, State]): CommandHandlerBuilderByState[Command, Event, S2, State]
Compose this builder with another builder.
Compose this builder with another builder. The handlers in this builder will be tried first followed by the handlers in
other
. - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from CommandHandlerBuilderByState[Command, Event, S, State] toStringFormat[CommandHandlerBuilderByState[Command, Event, S, State]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (CommandHandlerBuilderByState[Command, Event, S, State], B)
- Implicit
- This member is added by an implicit conversion from CommandHandlerBuilderByState[Command, Event, S, State] toArrowAssoc[CommandHandlerBuilderByState[Command, Event, S, State]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.