sealed class EffectFactories[Event, State] extends AnyRef

Factory methods for creating Effect directives - how an event sourced actor reacts on a command. Created via EventSourcedBehavior.Effect.

Not for user extension

Annotations
@DoNotInherit()
Source
Effect.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EffectFactories
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new EffectFactories()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from EffectFactories[Event, State] toany2stringadd[EffectFactories[Event, State]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EffectFactories[Event, State], B)
    Implicit
    This member is added by an implicit conversion from EffectFactories[Event, State] toArrowAssoc[EffectFactories[Event, State]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def async(effect: CompletionStage[Effect[Event, State]]): Effect[Event, State]

    Asynchronous command handling.

    Asynchronous command handling. The effect is run when the CompletionStage has been completed. Any incoming commands are stashed and processed later, after current command, when the CompletionStage has been completed.

    This can for example be used for retrieval of external information before validating the command.

  8. def asyncReply(effect: CompletionStage[ReplyEffect[Event, State]]): ReplyEffect[Event, State]

    Same as EffectFactories.async when the EventSourcedBehavior is created with EventSourcedBehaviorWithEnforcedReplies.

  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  10. def ensuring(cond: (EffectFactories[Event, State]) => Boolean, msg: => Any): EffectFactories[Event, State]
    Implicit
    This member is added by an implicit conversion from EffectFactories[Event, State] toEnsuring[EffectFactories[Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (EffectFactories[Event, State]) => Boolean): EffectFactories[Event, State]
    Implicit
    This member is added by an implicit conversion from EffectFactories[Event, State] toEnsuring[EffectFactories[Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): EffectFactories[Event, State]
    Implicit
    This member is added by an implicit conversion from EffectFactories[Event, State] toEnsuring[EffectFactories[Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): EffectFactories[Event, State]
    Implicit
    This member is added by an implicit conversion from EffectFactories[Event, State] toEnsuring[EffectFactories[Event, State]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def noReply(): 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 noReply 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.

  21. def none(): EffectBuilder[Event, State]

    Do not persist anything

  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. final def persist(events: List[Event]): EffectBuilder[Event, State]

    Persist all of a the given events.

    Persist all of a the given events. Each event will be applied through applyEffect separately but not until all events has been persisted. If callback is added through EffectBuilder.thenRun that will invoked after all the events has been persisted.

  25. final def persist(event: Event): EffectBuilder[Event, State]

    Persist a single event

  26. def reply[ReplyMessage](replyTo: ActorRef[ReplyMessage], replyWithMessage: ReplyMessage): ReplyEffect[Event, State]

    Send a reply message to the command.

    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 EventSourcedBehavior is created with EventSourcedBehaviorWithEnforcedReplies. 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.

  27. def stash(): ReplyEffect[Event, State]

    Stash the current command.

    Stash the current command. Can be unstashed later with Effect.thenUnstashAll or EffectFactories.unstashAll.

    Note that the stashed commands are kept in an in-memory buffer, so in case of a crash they will not be processed. They will also be discarded if the actor is restarted (or stopped) due to that an exception was thrown from processing a command or side effect after persisting. The stash buffer is preserved for persist failures if an onPersistFailure backoff supervisor strategy is defined.

    Side effects can be chained with thenRun.

  28. def stop(): EffectBuilder[Event, State]

    Stop this persistent actor

  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. def unhandled(): EffectBuilder[Event, State]

    This command is not handled, but it is not an error that it isn't.

  32. def unstashAll(): 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 another unstashAll.

    See also

    EffectBuilder.thenUnstashAll

  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EffectFactories[Event, State] toStringFormat[EffectFactories[Event, 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 of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (EffectFactories[Event, State], B)
    Implicit
    This member is added by an implicit conversion from EffectFactories[Event, State] toArrowAssoc[EffectFactories[Event, 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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromEffectFactories[Event, State] to any2stringadd[EffectFactories[Event, State]]

Inherited by implicit conversion StringFormat fromEffectFactories[Event, State] to StringFormat[EffectFactories[Event, State]]

Inherited by implicit conversion Ensuring fromEffectFactories[Event, State] to Ensuring[EffectFactories[Event, State]]

Inherited by implicit conversion ArrowAssoc fromEffectFactories[Event, State] to ArrowAssoc[EffectFactories[Event, State]]

Ungrouped