abstract class EffectBuilder[+Event, State] extends Effect[Event, State]
A command handler returns an Effect
directive that defines what event or events to persist.
Additional side effects can be performed in the callback thenRun
Instances of Effect
are available through factories EventSourcedBehavior.Effect.
Not intended for user extension.
- Self Type
- EffectImpl[Event, State]
- Annotations
- @DoNotInherit()
- Source
- Effect.scala
- Alphabetic
- By Inheritance
- EffectBuilder
- Effect
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new EffectBuilder()
Abstract Value Members
-
abstract
def
thenNoReply(): ReplyEffect[Event, State]
When EventSourcedBehaviorWithEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect.
When EventSourcedBehaviorWithEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect. This
thenNoReply
can be used as a conscious decision that a reply shouldn't be sent for a specific command or the reply will be sent later. -
abstract
def
thenStop(): EffectBuilder[Event, State]
The side effect is to stop the actor
-
abstract
def
thenUnstashAll(): Effect[Event, State]
Unstash the commands that were stashed with
EffectFactories.stash
.Unstash the commands that were stashed with
EffectFactories.stash
.It's allowed to stash messages while unstashing. Those newly added commands will not be processed by this
unstashAll
effect and have to be unstashed by anotherunstashAll
.
Concrete 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 EffectBuilder[Event, State] to any2stringadd[EffectBuilder[Event, State]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (EffectBuilder[Event, State], B)
- Implicit
- This member is added by an implicit conversion from EffectBuilder[Event, State] to ArrowAssoc[EffectBuilder[Event, 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
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
def
ensuring(cond: (EffectBuilder[Event, State]) ⇒ Boolean, msg: ⇒ Any): EffectBuilder[Event, State]
- Implicit
- This member is added by an implicit conversion from EffectBuilder[Event, State] to Ensuring[EffectBuilder[Event, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (EffectBuilder[Event, State]) ⇒ Boolean): EffectBuilder[Event, State]
- Implicit
- This member is added by an implicit conversion from EffectBuilder[Event, State] to Ensuring[EffectBuilder[Event, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): EffectBuilder[Event, State]
- Implicit
- This member is added by an implicit conversion from EffectBuilder[Event, State] to Ensuring[EffectBuilder[Event, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): EffectBuilder[Event, State]
- Implicit
- This member is added by an implicit conversion from EffectBuilder[Event, State] to Ensuring[EffectBuilder[Event, State]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from EffectBuilder[Event, State] to StringFormat[EffectBuilder[Event, State]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
thenReply[ReplyMessage](cmd: ExpectingReply[ReplyMessage], replyWithMessage: Function[State, ReplyMessage]): ReplyEffect[Event, State]
Send a reply message to the command, which implements ExpectingReply.
Send a reply message to the command, which implements ExpectingReply. The type of the reply message must conform to the type specified in ExpectingReply.replyTo
ActorRef
.This has the same semantics as
cmd.replyTo().tell
.It is provided as a convenience (reducing boilerplate) and a way to enforce that replies are not forgotten when the
EventSourcedBehavior
is created with EventSourcedBehaviorWithEnforcedReplies. WhenwithEnforcedReplies
is used there will be compilation errors if the returned effect isn't a ReplyEffect. The reply message will be sent also ifwithEnforcedReplies
isn't used, but then the compiler will not help finding mistakes. -
final
def
thenRun(callback: japi.function.Effect): EffectBuilder[Event, State]
Run the given callback.
Run the given callback. Callbacks are run sequentially.
-
final
def
thenRun[NewState <: State](callback: Procedure[NewState]): EffectBuilder[Event, State]
Run the given callback.
Run the given callback. Callbacks are run sequentially.
- NewState
The type of the state after the event is persisted, when not specified will be the same as
State
but if a known subtype ofState
is expected that can be specified instead (preferrably by explicitly typing the lambda parameter like so:thenRun((SubState state) -> { ... })
). If the state is not of the expected type an java.lang.ClassCastException is thrown.
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (EffectBuilder[Event, State], B)
- Implicit
- This member is added by an implicit conversion from EffectBuilder[Event, State] to ArrowAssoc[EffectBuilder[Event, State]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc