Type Members

1.  trait ChangeEventHandler[Command, State, ChangeEvent] extends AnyRef

   API May Change: Implement this interface and use it in DurableStateBehavior#withChangeEventHandler to store additional change event when the state is updated.

   API May Change: Implement this interface and use it in DurableStateBehavior#withChangeEventHandler to store additional change event when the state is updated. The event can be used in Projections.

   The updateHandler and deleteHandler are invoked after the ordinary command handler. Be aware of that if the state is mutable and modified by the command handler the previous state parameter of the updateHandler will also include the modification, since it's the same instance. If that is a problem you need to use immutable state and create a new state instance when modifying it in the command handler.

   Annotations

   @ApiMayChange()

2.  trait CommandHandler[Command, State] extends AnyRef

   FunctionalInterface for reacting on commands

   FunctionalInterface for reacting on commands

   Used with CommandHandlerBuilder to setup the behavior of a DurableStateBehavior

   Annotations

   @FunctionalInterface()

3.  final class CommandHandlerBuilder[Command, State] extends AnyRef
4.  final class CommandHandlerBuilderByState[Command, S <: State, State] extends AnyRef
5.  trait CommandHandlerWithReply[Command, State] extends CommandHandler[Command, State]

   FunctionalInterface for reacting on commands

   FunctionalInterface for reacting on commands

   Used with CommandHandlerWithReplyBuilder to setup the behavior of a DurableStateBehaviorWithEnforcedReplies

   Annotations

   @FunctionalInterface()

6.  final class CommandHandlerWithReplyBuilder[Command, State] extends AnyRef
7.  final class CommandHandlerWithReplyBuilderByState[Command, S <: State, State] extends AnyRef
8.  abstract class DurableStateBehavior[Command, State] extends DeferredBehavior[Command]

   A Behavior for a persistent actor with durable storage of its state.

   A Behavior for a persistent actor with durable storage of its state.

   For projects using Java 17 and newer, also see DurableStateOnCommandBehavior

   API May Change

   Annotations

   @ApiMayChange()

9.  abstract class DurableStateBehaviorWithEnforcedReplies[Command, State] extends DurableStateBehavior[Command, State]

   A DurableStateBehavior that is enforcing that replies to commands are not forgotten.

   A DurableStateBehavior that is enforcing that replies to commands are not forgotten. There will be compilation errors if the returned effect isn't a ReplyEffect, which can be created with Effects().reply, Effects().noReply, EffectBuilder.thenReply, or EffectBuilder.thenNoReply.

10.  abstract class DurableStateOnCommandBehavior[Command, State] extends DeferredBehavior[Command]

    A Behavior for a persistent actor with durable storage of its state for projects built with Java 17 or newer where message handling can be done * using switch pattern match.

    A Behavior for a persistent actor with durable storage of its state for projects built with Java 17 or newer where message handling can be done * using switch pattern match.

    For building event sourced actors with Java versions before 17, see DurableStateBehavior

    API May Change

    Annotations

    @ApiMayChange()

11.  abstract class DurableStateOnCommandWithReplyBehavior[Command, State] extends DeferredBehavior[Command]

    A Behavior for a persistent actor with durable storage of its state for projects built with Java 17 or newer where message handling can be done * using switch pattern match.

    A Behavior for a persistent actor with durable storage of its state for projects built with Java 17 or newer where message handling can be done * using switch pattern match.

    Enforces replies to every received command.

    For building event sourced actors with Java versions before 17, see DurableStateBehavior

    API May Change

    Annotations

    @ApiMayChange()

12.  trait Effect[State] extends AnyRef

    A command handler returns an Effect directive that defines what state to persist.

    A command handler returns an Effect directive that defines what state to persist.

    Instances of Effect are available through factories DurableStateBehavior.Effect.

    Not intended for user extension.

    Annotations

    @DoNotInherit()

13.  abstract class EffectBuilder[State] extends Effect[State]

    A command handler returns an Effect directive that defines what state to persist.

    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.

    Annotations

    @DoNotInherit()

14.  sealed class EffectFactories[State] extends AnyRef

    Factory methods for creating Effect directives - how a DurableStateBehavior reacts on a command.

    Factory methods for creating Effect directives - how a DurableStateBehavior reacts on a command. Created via DurableStateBehavior.Effect.

    Not for user extension

    API May Change

    Annotations

    @ApiMayChange() @DoNotInherit()

15.  trait ReplyEffect[State] extends Effect[State]

    DurableStateBehaviorWithEnforcedReplies can be used to enforce that replies are not forgotten.

    DurableStateBehaviorWithEnforcedReplies can be used to enforce that replies are not forgotten. Then there will be compilation errors if the returned effect isn't a ReplyEffect, which can be created with Effects().reply, Effects().noReply, EffectBuilder.thenReply, or EffectBuilder.thenNoReply.

    Annotations

    @DoNotInherit()

16.  final class SignalHandler[State] extends AnyRef
17.  final class SignalHandlerBuilder[State] extends AnyRef

    Mutable builder for handling signals in DurableStateBehavior

    Mutable builder for handling signals in DurableStateBehavior

    Not for user instantiation, use DurableStateBehavior.newSignalHandlerBuilder to get an instance.