Package org.apache.pekko.persistence.typed.state.javadsl

Class EffectBuilder<State>

java.lang.Object
org.apache.pekko.persistence.typed.state.javadsl.EffectBuilder<State>
All Implemented Interfaces:
Effect<State>
Direct Known Subclasses:
PersistNothing$, Stash$, Unhandled$
public abstract class EffectBuilder<State> extends Object implements Effect<State>
A command handler returns an Effect directive that defines what state to persist.

Additional side effects can be performed in the callback thenRun

Instances of Effect are available through factories DurableStateBehavior.Effect.

Not intended for user extension.

  • Constructor Details

    • EffectBuilder

      public EffectBuilder()

  • Method Details

    • thenNoReply

      public abstract ReplyEffect<State> thenNoReply()
      When DurableStateBehaviorWithEnforcedReplies 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.

    • thenReply

      public <ReplyMessage> ReplyEffect<State> thenReply(ActorRef<ReplyMessage> replyTo, Function<State,ReplyMessage> replyWithMessage)
      Send a reply message to the command. The type of the reply message must conform to the type specified by the passed replyTo ActorRef.

      This has the same semantics as replyTo.tell.

      It is provided as a convenience (reducing boilerplate) and a way to enforce that replies are not forgotten when the DurableStateBehavior is created with DurableStateBehaviorWithEnforcedReplies. When withEnforcedReplies is used there will be compilation errors if the returned effect isn't a ReplyEffect. The reply message will be sent also if withEnforcedReplies isn't used, but then the compiler will not help finding mistakes.

    • thenRun

      public final <NewState extends State> EffectBuilder<State> thenRun(Procedure<NewState> callback)
      Run the given callback. Callbacks are run sequentially.

    • thenRun

      public final EffectBuilder<State> thenRun(Effect callback)
      Run the given callback. Callbacks are run sequentially.

    • thenStop

      public abstract EffectBuilder<State> thenStop()
      The side effect is to stop the actor

    • thenUnstashAll

      public abstract Effect<State> thenUnstashAll()
      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 another unstashAll.