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. 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()
Source
ChangeEventHandler.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChangeEventHandler
  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

Abstract Value Members

  1. abstract def deleteHandler(previousState: State, command: Command): ChangeEvent

    Store additional change event when the state is updated.

    Store additional change event when the state is updated. The event can be used in Projections.

    previousState

    Previous state before the delete.

    returns

    The change event to be stored.

  2. abstract def updateHandler(previousState: State, newState: State, command: Command): ChangeEvent

    Store additional change event when the state is updated.

    Store additional change event when the state is updated. The event can be used in Projections.

    previousState

    Previous state before the update.

    newState

    New state after the update.

    returns

    The change event to be stored.

Concrete 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 ChangeEventHandler[Command, State, ChangeEvent] toany2stringadd[ChangeEventHandler[Command, State, ChangeEvent]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ChangeEventHandler[Command, State, ChangeEvent], B)
    Implicit
    This member is added by an implicit conversion from ChangeEventHandler[Command, State, ChangeEvent] toArrowAssoc[ChangeEventHandler[Command, State, ChangeEvent]] 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (ChangeEventHandler[Command, State, ChangeEvent]) => Boolean, msg: => Any): ChangeEventHandler[Command, State, ChangeEvent]
    Implicit
    This member is added by an implicit conversion from ChangeEventHandler[Command, State, ChangeEvent] toEnsuring[ChangeEventHandler[Command, State, ChangeEvent]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ChangeEventHandler[Command, State, ChangeEvent]) => Boolean): ChangeEventHandler[Command, State, ChangeEvent]
    Implicit
    This member is added by an implicit conversion from ChangeEventHandler[Command, State, ChangeEvent] toEnsuring[ChangeEventHandler[Command, State, ChangeEvent]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ChangeEventHandler[Command, State, ChangeEvent]
    Implicit
    This member is added by an implicit conversion from ChangeEventHandler[Command, State, ChangeEvent] toEnsuring[ChangeEventHandler[Command, State, ChangeEvent]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ChangeEventHandler[Command, State, ChangeEvent]
    Implicit
    This member is added by an implicit conversion from ChangeEventHandler[Command, State, ChangeEvent] toEnsuring[ChangeEventHandler[Command, State, ChangeEvent]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. 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 ChangeEventHandler[Command, State, ChangeEvent] toStringFormat[ChangeEventHandler[Command, State, ChangeEvent]] 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): (ChangeEventHandler[Command, State, ChangeEvent], B)
    Implicit
    This member is added by an implicit conversion from ChangeEventHandler[Command, State, ChangeEvent] toArrowAssoc[ChangeEventHandler[Command, State, ChangeEvent]] 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 fromChangeEventHandler[Command, State, ChangeEvent] to any2stringadd[ChangeEventHandler[Command, State, ChangeEvent]]

Inherited by implicit conversion StringFormat fromChangeEventHandler[Command, State, ChangeEvent] to StringFormat[ChangeEventHandler[Command, State, ChangeEvent]]

Inherited by implicit conversion Ensuring fromChangeEventHandler[Command, State, ChangeEvent] to Ensuring[ChangeEventHandler[Command, State, ChangeEvent]]

Inherited by implicit conversion ArrowAssoc fromChangeEventHandler[Command, State, ChangeEvent] to ArrowAssoc[ChangeEventHandler[Command, State, ChangeEvent]]

Ungrouped