Interpreter

Instance Constructors

new Interpreter()

Type Members

type Aggregate = A

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
Interpreter → AggregateAliases
type Command = ProtocolAliases.Protocol.ProtocolCommand

Alias for Aggregate's ProtocolCommand
Alias for Aggregate's ProtocolCommand

Definition Classes
ProtocolAliases
type Event = ProtocolAliases.Protocol.ProtocolEvent

Alias for Aggregate's ProtocolEvent
Alias for Aggregate's ProtocolEvent

Definition Classes
ProtocolAliases
type Events = Seq[Event]

Alias for an immutable Seq of Aggregate's ProtocolEvent
Alias for an immutable Seq of Aggregate's ProtocolEvent

Definition Classes
ProtocolAliases
type Id = A.Id

Alias for Aggregate#Id
Alias for Aggregate#Id

Definition Classes
AggregateAliases
type InterpreterFunction = PartialFunction[(Command, CommandHandlerInvoker[Command, Event]), F[Events]]
type Protocol = A.Protocol

Alias for Aggregate#Protocol
Alias for Aggregate#Protocol

Definition Classes
AggregateAliases → ProtocolAliases

Abstract Value Members

abstract def applyCommand(state: State[Aggregate], cmd: Command): F[(Events, State[A])]
abstract def behavior: Behavior[A]

Attributes
protected
abstract def fromTry[B](any: Try[B]): F[B]

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

abstract def interpret: InterpreterFunction

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

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def onCommand(state: State[Aggregate], cmd: Command): F[Events]
final def onEvent(state: State[Aggregate], evt: Event): State[Aggregate]

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

Exceptions thrown
MissingEventHandlerException if no Event handler is defined for the passed event.
final def onEvents(state: State[Aggregate], evts: Events): F[State[Aggregate]]

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

Exceptions thrown
MissingEventHandlerException if no Event handler is defined for one of the passed events.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package interpreters

abstract class Interpreter[A <: AggregateLike, F[_]] extends AggregateAliases

Instance Constructors

new Interpreter()

Type Members

type Aggregate = A

type Command = ProtocolAliases.Protocol.ProtocolCommand

type Event = ProtocolAliases.Protocol.ProtocolEvent

type Events = Seq[Event]

type Id = A.Id

type InterpreterFunction = PartialFunction[(Command, CommandHandlerInvoker[Command, Event]), F[Events]]

type Protocol = A.Protocol

Abstract Value Members

abstract def applyCommand(state: State[Aggregate], cmd: Command): F[(Events, State[A])]

abstract def behavior: Behavior[A]

abstract def fromTry[B](any: Try[B]): F[B]

abstract def interpret: InterpreterFunction

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def onCommand(state: State[Aggregate], cmd: Command): F[Events]

final def onEvent(state: State[Aggregate], evt: Event): State[Aggregate]

final def onEvents(state: State[Aggregate], evts: Events): F[State[Aggregate]]

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AggregateAliases

Inherited from ProtocolAliases

Inherited from AnyRef

Inherited from Any

Ungrouped