Class/Object

io.funcqrs.interpreters

IdentityInterpreter

Related Docs: object IdentityInterpreter | package interpreters

Permalink

class IdentityInterpreter[A <: AggregateLike] extends Interpreter[A, Identity]

An Interpreter with F[_] bounded to Identity.

All command handling are interpreted to Identity of Events (ie: the pure value).

Will block on any async operation defined by Behavior.

This interpreter should be used for testing and / or for behaviors that preferably don't define any async operation.

A

- an Aggregate type

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IdentityInterpreter
  2. Interpreter
  3. AggregateAliases
  4. ProtocolAliases
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IdentityInterpreter(behavior: Behavior[A], atMost: Duration = 5.seconds)

    Permalink

    behavior

    - a Aggregate Behavior

    atMost

    - the maximum duration we are to wait before Futures timeout.

Type Members

  1. type Aggregate = A

    Permalink

    The Aggregate type.

    The Aggregate type. This is the only (abstract) type member to be defined.

    All other type members are aliases defined by type projection of inner types from Aggregate type itself.

    Definition Classes
    InterpreterAggregateAliases
  2. type Command = ProtocolAliases.Protocol.ProtocolCommand

    Permalink

    Alias for Aggregate's ProtocolCommand

    Alias for Aggregate's ProtocolCommand

    Definition Classes
    ProtocolAliases
  3. type Event = ProtocolAliases.Protocol.ProtocolEvent

    Permalink

    Alias for Aggregate's ProtocolEvent

    Alias for Aggregate's ProtocolEvent

    Definition Classes
    ProtocolAliases
  4. type Events = Seq[Event]

    Permalink

    Alias for an immutable Seq of Aggregate's ProtocolEvent

    Alias for an immutable Seq of Aggregate's ProtocolEvent

    Definition Classes
    ProtocolAliases
  5. type Id = A.Id

    Permalink

    Alias for Aggregate#Id

    Alias for Aggregate#Id

    Definition Classes
    AggregateAliases
  6. type InterpreterFunction = PartialFunction[(Command, CommandHandlerInvoker[Command, Event]), Identity[Events]]

    Permalink
    Definition Classes
    Interpreter
  7. type Protocol = A.Protocol

    Permalink

    Alias for Aggregate#Protocol

    Alias for Aggregate#Protocol

    Definition Classes
    AggregateAliasesProtocolAliases

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def applyCommand(state: State[A], cmd: Command): (Events, State[A])

    Permalink
    Definition Classes
    IdentityInterpreterInterpreter
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val behavior: Behavior[A]

    Permalink

    - a Aggregate Behavior

    - a Aggregate Behavior

    Definition Classes
    IdentityInterpreterInterpreter
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def fromTry[B](any: Try[B]): Identity[B]

    Permalink

    Natural transformation from Try to a F

    Natural transformation from Try to a F

    In the occurrence of missing behavior, we have no other choice than emitting a MissingBehaviorException. This is wrapped in a Try that must be transformed to the correct error type for F[_]

    any

    - the produced events

    Attributes
    protected
    Definition Classes
    IdentityInterpreterInterpreter
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. def interpret: InterpreterFunction

    Permalink

    The interpret PartialFunction is specific to each interpreter.

    The interpret PartialFunction is specific to each interpreter. It's responsible for executing the command and lifting the output to F[_]

    // example of interpret for an AsyncInterpreter
      def interpret: InterpreterFunction = {
        case (cmd, IdCommandHandlerInvoker(handler))      => Future.successful(handler(cmd))
        case (cmd, TryCommandHandlerInvoker(handler))     => Future.fromTry(handler(cmd))
        case (cmd, FutureCommandHandlerInvoker(handler))  => handler(cmd)
      }
    Attributes
    protected
    Definition Classes
    IdentityInterpreterInterpreter
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def onCommand(state: State[Aggregate], cmd: Command): Identity[Events]

    Permalink
    Definition Classes
    Interpreter
  20. final def onEvent(state: State[Aggregate], evt: Event): State[Aggregate]

    Permalink

    Apply all 'evt' on passed 'state'.

    Apply all 'evt' on passed 'state'.

    state

    - the aggregate current state

    evt

    - event to be applied

    returns

    new aggregate state after applying event

    Definition Classes
    Interpreter
    Exceptions thrown

    MissingEventHandlerException if no Event handler is defined for the passed event.

  21. final def onEvents(state: State[Aggregate], evts: Events): Identity[State[Aggregate]]

    Permalink

    Apply all 'evts' on passed 'state'.

    Apply all 'evts' on passed 'state'.

    state

    - the aggregate current state

    evts

    - events to be applied

    returns

    new aggregate state after applying all events

    Definition Classes
    Interpreter
    Exceptions thrown

    MissingEventHandlerException if no Event handler is defined for one of the passed events.

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Interpreter[A, Identity]

Inherited from AggregateAliases

Inherited from ProtocolAliases

Inherited from AnyRef

Inherited from Any

Ungrouped