Package akka.persistence.typed.javadsl
Class EffectBuilder<Event,State>
- java.lang.Object
-
- akka.persistence.typed.javadsl.EffectBuilder<Event,State>
-
- Type Parameters:
NewState
- The type of the state after the event is persisted, when not specified will be the same asState
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 anClassCastException
is thrown.
- All Implemented Interfaces:
Effect<Event,State>
- Direct Known Subclasses:
EffectImpl
public abstract class EffectBuilder<Event,State> extends java.lang.Object implements Effect<Event,State>
Run the given callback. Callbacks are run sequentially.
-
-
Constructor Summary
Constructors Constructor Description EffectBuilder()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract ReplyEffect<Event,State>
thenNoReply()
WhenEventSourcedBehaviorWithEnforcedReplies
is used there will be compilation errors if the returned effect isn't aReplyEffect
.<ReplyMessage>
ReplyEffect<Event,State>thenReply(ExpectingReply<ReplyMessage> cmd, Function<State,ReplyMessage> replyWithMessage)
Send a reply message to the command, which implementsExpectingReply
.EffectBuilder<Event,State>
thenRun(Effect callback)
Run the given callback.<NewState extends State>
EffectBuilder<Event,State>thenRun(Procedure<NewState> callback)
abstract EffectBuilder<Event,State>
thenStop()
The side effect is to stop the actorabstract Effect<Event,State>
thenUnstashAll()
Unstash the commands that were stashed withEffectFactories.stash
.
-
-
-
Method Detail
-
thenNoReply
public abstract ReplyEffect<Event,State> thenNoReply()
WhenEventSourcedBehaviorWithEnforcedReplies
is used there will be compilation errors if the returned effect isn't aReplyEffect
. ThisthenNoReply
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.- Returns:
- (undocumented)
-
thenReply
public <ReplyMessage> ReplyEffect<Event,State> thenReply(ExpectingReply<ReplyMessage> cmd, Function<State,ReplyMessage> replyWithMessage)
Send a reply message to the command, which implementsExpectingReply
. The type of the reply message must conform to the type specified inExpectingReply.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 withEventSourcedBehaviorWithEnforcedReplies
. WhenwithEnforcedReplies
is used there will be compilation errors if the returned effect isn't aReplyEffect
. The reply message will be sent also ifwithEnforcedReplies
isn't used, but then the compiler will not help finding mistakes.- Parameters:
cmd
- (undocumented)replyWithMessage
- (undocumented)- Returns:
- (undocumented)
-
thenRun
public final <NewState extends State> EffectBuilder<Event,State> thenRun(Procedure<NewState> callback)
-
thenRun
public final EffectBuilder<Event,State> thenRun(Effect callback)
Run the given callback. Callbacks are run sequentially.- Parameters:
callback
- (undocumented)- Returns:
- (undocumented)
-
thenStop
public abstract EffectBuilder<Event,State> thenStop()
The side effect is to stop the actor
-
thenUnstashAll
public abstract Effect<Event,State> thenUnstashAll()
Unstash the commands that were stashed withEffectFactories.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
.- Returns:
- (undocumented)
-
-