Type Members

1.  trait Action extends RiddlValue

   Base class for all actions.

   Base class for all actions. Actions are used in the "then" and "but" clauses of a Gherkin example such as in the body of a handler's on clause or in the definition of a Function. The subclasses define different kinds of actions that can be used.

   Definition Classes

   AbstractDefinitions

2.  trait AlwaysEmpty extends Definition

   Definition Classes

   AbstractDefinitions

3.  case class BlockDescription(loc: At = At.empty, lines: Seq[LiteralString] = Seq.empty[LiteralString]) extends Description with Product with Serializable

   Definition Classes

   AbstractDefinitions

4.  trait BrieflyDescribedValue extends RiddlValue

   Definition Classes

   AbstractDefinitions

5.  trait Container[+D <: RiddlValue] extends RiddlValue

   Base trait of any definition that is also a ContainerValue

   Base trait of any definition that is also a ContainerValue

   D

   The kind of definition that is contained by the container

   Definition Classes

   AbstractDefinitions

6.  trait Definition extends DescribedValue with BrieflyDescribedValue with Container[Definition]

   Base trait for all definitions requiring an identifier for the definition and providing the identify method to yield a string that provides the kind and name

   Base trait for all definitions requiring an identifier for the definition and providing the identify method to yield a string that provides the kind and name

   Definition Classes

   AbstractDefinitions

7.  trait DescribedValue extends RiddlValue

   Base trait of all values that have an optional Description

   Base trait of all values that have an optional Description

   Definition Classes

   AbstractDefinitions

8.  trait Description extends RiddlValue

   The description of a definition.

   The description of a definition. All definitions have a name and an optional description. This class provides the description part.

   Definition Classes

   AbstractDefinitions

9.  case class FileDescription(loc: At, file: Path) extends Description with Product with Serializable

   Definition Classes

   AbstractDefinitions

10.  trait FunctionDefinition extends Definition

    Base trait of any definition that is in the content of a function.

    Base trait of any definition that is in the content of a function.

    Definition Classes

    AbstractDefinitions

11.  trait GherkinClause extends GherkinValue

    Base class of one of the four Gherkin clauses (Given, When, Then, But)

    Base class of one of the four Gherkin clauses (Given, When, Then, But)

    Definition Classes

    AbstractDefinitions

12.  trait GherkinValue extends RiddlValue

    Base class of any Gherkin value

    Base class of any Gherkin value

    Definition Classes

    AbstractDefinitions

13.  case class Identifier(loc: At, value: String) extends RiddlValue with Product with Serializable

    A RiddlValue that is a parsed identifier, typically the name of a definition.

    A RiddlValue that is a parsed identifier, typically the name of a definition.

    loc

    The location in the input where the identifier starts

    value

    The parsed value of the identifier

    Definition Classes

    AbstractDefinitions

14.  trait LeafDefinition extends Definition

    Definition Classes

    AbstractDefinitions

15.  case class LiteralString(loc: At, s: String) extends RiddlValue with Product with Serializable

    Represents a literal string parsed between quote characters in the input

    Represents a literal string parsed between quote characters in the input

    loc

    The location in the input of the opening quote character

    s

    The parsed value of the string content

    Definition Classes

    AbstractDefinitions

16.  case class PathIdentifier(loc: At, value: Seq[String]) extends RiddlValue with Product with Serializable

    Represents a segmented identifier to a definition in the model.

    Represents a segmented identifier to a definition in the model. Path Identifiers are parsed from a dot-separated list of identifiers in the input. Path identifiers are used to reference other definitions in the model.

    loc

    Location in the input of the first letter of the path identifier

    value

    The list of strings that make up the path identifier

    Definition Classes

    AbstractDefinitions

17.  trait ProjectionDefinition extends Definition

    Base trait of any definition that occurs in the body of a projection

    Base trait of any definition that occurs in the body of a projection

    Definition Classes

    AbstractDefinitions

18.  abstract class Reference[+T <: Definition] extends RiddlValue

    A reference to a definition of a specific type.

    A reference to a definition of a specific type.

    T

    The type of definition to which the references refers.

    Definition Classes

    AbstractDefinitions

19.  trait RiddlNode extends AnyRef

    The root trait of all things RIDDL AST.

    The root trait of all things RIDDL AST. Every node in the tree is a RiddlNode.

    Definition Classes

    AbstractDefinitions

20.  trait RiddlValue extends RiddlNode

    The root trait of all parsable values.

    The root trait of all parsable values. If a parser returns something, its a RiddlValue. The distinguishing factor is the inclusion of the parsing location given by the loc field.

    Definition Classes

    AbstractDefinitions

21.  trait SagaDefinition extends Definition

    Base trait of definitions that are part of a Saga Definition

    Base trait of definitions that are part of a Saga Definition

    Definition Classes

    AbstractDefinitions

22.  trait StateDefinition extends Definition

    Base trait of definitions that are part of a Saga Definition

    Base trait of definitions that are part of a Saga Definition

    Definition Classes

    AbstractDefinitions

23.  case class URLDescription(loc: At, url: URL) extends Description with Product with Serializable

    Definition Classes

    AbstractDefinitions

24.  sealed abstract class AdaptorOption extends OptionValue
25.  case class AdaptorTechnologyOption(loc: At, args: Seq[Options.LiteralString]) extends AdaptorOption with Product with Serializable
26.  sealed abstract class ApplicationOption extends OptionValue
27.  case class ApplicationTechnologyOption(loc: At, args: Seq[Options.LiteralString] = Seq.empty[LiteralString]) extends ApplicationOption with Product with Serializable
28.  sealed abstract class ConnectorOption extends OptionValue
29.  case class ConnectorPersistentOption(loc: At) extends ConnectorOption with Product with Serializable
30.  case class ConnectorTechnologyOption(loc: At, args: Seq[Options.LiteralString]) extends ConnectorOption with Product with Serializable
31.  sealed abstract class ContextOption extends OptionValue

    Base trait for all options a Context can have.

32.  case class ContextPackageOption(loc: At, args: Seq[Options.LiteralString]) extends ContextOption with Product with Serializable
33.  case class ContextTechnologyOption(loc: At, args: Seq[Options.LiteralString]) extends ContextOption with Product with Serializable
34.  case class DomainExternalOption(loc: At) extends DomainOption with Product with Serializable
35.  sealed abstract class DomainOption extends OptionValue

    Base trait for all options a Domain can have.

36.  case class DomainPackageOption(loc: At, args: Seq[Options.LiteralString]) extends DomainOption with Product with Serializable

    A context's "wrapper" option.

    A context's "wrapper" option. This option suggests the bounded context is to be used as a wrapper around an external system and is therefore at the boundary of the context map

    loc

    The location of the wrapper option

37.  case class DomainTechnologyOption(loc: At, args: Seq[Options.LiteralString]) extends DomainOption with Product with Serializable
38.  case class EntityEventSourced(loc: At) extends EntityOption with Product with Serializable

    An EntityOption that indicates that this entity should store its state in an event sourced fashion.

    An EntityOption that indicates that this entity should store its state in an event sourced fashion.

    loc

    The location of the option.

39.  case class EntityIsAggregate(loc: At) extends EntityOption with Product with Serializable

    An EntityOption that indicates that this entity is an aggregate root entity through which all commands and queries are sent on behalf of the aggregated entities.

    An EntityOption that indicates that this entity is an aggregate root entity through which all commands and queries are sent on behalf of the aggregated entities.

    loc

    The location of the option

40.  case class EntityIsAvailable(loc: At) extends EntityOption with Product with Serializable

    A EntityOption that indicates that this entity favors availability over consistency in the CAP theorem.

    A EntityOption that indicates that this entity favors availability over consistency in the CAP theorem.

    loc

    The location of the option.

41.  case class EntityIsConsistent(loc: At) extends EntityOption with Product with Serializable

    An EntityOption that indicates that this entity favors consistency over availability in the CAP theorem.

    An EntityOption that indicates that this entity favors consistency over availability in the CAP theorem.

    loc

    The location of the option.

42.  case class EntityIsDevice(loc: At) extends EntityOption with Product with Serializable
43.  case class EntityIsFiniteStateMachine(loc: At) extends EntityOption with Product with Serializable

    An EntityOption that indicates that this entity is intended to implement a finite state machine.

    An EntityOption that indicates that this entity is intended to implement a finite state machine.

    loc

    The location of the option.

44.  case class EntityKind(loc: At, args: Seq[Options.LiteralString]) extends EntityOption with Product with Serializable

    An EntityOption that indicates the general kind of entity being defined.

    An EntityOption that indicates the general kind of entity being defined. This option takes a value which provides the kind. Examples of useful kinds are "device", "actor", "concept", "machine", and similar kinds of entities. This entity option may be used by downstream AST processors, especially code generators.

    loc

    The location of the entity kind option

    args

    The argument to the option

45.  case class EntityMessageQueue(loc: At) extends EntityOption with Product with Serializable

    An EntityOption that indicates that this entity should allow receipt of commands and queries via a message queue.

    An EntityOption that indicates that this entity should allow receipt of commands and queries via a message queue.

    loc

    The location at which this option occurs.

46.  sealed abstract class EntityOption extends EntityValue with OptionValue

    Abstract base class of options for entities

47.  case class EntityTechnologyOption(loc: At, args: Seq[Options.LiteralString]) extends EntityOption with Product with Serializable
48.  case class EntityTransient(loc: At) extends EntityOption with Product with Serializable

    An EntityOption that indicates that this entity should not persist its state and is only available in transient memory.

    An EntityOption that indicates that this entity should not persist its state and is only available in transient memory. All entity values will be lost when the service is stopped.

    loc

    The location of the option.

49.  sealed trait EntityValue extends RiddlValue

    Base trait of any value used in the definition of an entity

50.  case class EntityValueOption(loc: At) extends EntityOption with Product with Serializable

    An EntityOption that indicates that this entity should store only the latest value without using event sourcing.

    An EntityOption that indicates that this entity should store only the latest value without using event sourcing. In other words, the history of changes is not stored.

    loc

    The location of the option

51.  sealed abstract class FunctionOption extends OptionValue

    Base class of all function options

52.  case class GatewayOption(loc: At) extends ContextOption with Product with Serializable

    A context's "gateway" option that suggests the bounded context is intended to be an application gateway to the model.

    A context's "gateway" option that suggests the bounded context is intended to be an application gateway to the model. Gateway's provide authentication and authorization access to external systems, usually user applications.

    loc

    The location of the gateway option

53.  sealed abstract class HandlerOption extends OptionValue
54.  trait OptionValue extends RiddlValue

    Base trait for option values for any option of a definition.

55.  case class ParallelOption(loc: At) extends SagaOption with Product with Serializable

    A SagaOption that indicates parallel execution of the saga actions.

    A SagaOption that indicates parallel execution of the saga actions.

    loc

    The location of the parallel option

56.  case class PartialHandlerOption(loc: At) extends HandlerOption with Product with Serializable
57.  sealed abstract class ProjectionOption extends OptionValue
58.  case class ProjectionTechnologyOption(loc: At, args: Seq[Options.LiteralString]) extends ProjectionOption with Product with Serializable
59.  sealed abstract class RepositoryOption extends OptionValue
60.  case class RepositoryTechnologyOption(loc: At, args: Seq[Options.LiteralString]) extends RepositoryOption with Product with Serializable
61.  sealed abstract class SagaOption extends OptionValue

    Base trait for all options applicable to a saga.

62.  case class SagaTechnologyOption(loc: At, args: Seq[Options.LiteralString]) extends SagaOption with Product with Serializable
63.  case class SequentialOption(loc: At) extends SagaOption with Product with Serializable

    A SagaOption that indicates sequential (serial) execution of the saga actions.

    A SagaOption that indicates sequential (serial) execution of the saga actions.

    loc

    The location of the sequential option

64.  case class ServiceOption(loc: At) extends ContextOption with Product with Serializable

    A context's "service" option.

    A context's "service" option. This option suggests the bounded context is intended to be a DDD service, similar to a wrapper but without any persistent state and more of a stateless service aspect to its nature

    loc

    The location at which the option occurs

65.  sealed abstract class StoryOption extends OptionValue
66.  case class StorySynchronousOption(loc: At) extends StoryOption with Product with Serializable
67.  case class StoryTechnologyOption(loc: At, args: Seq[Options.LiteralString]) extends StoryOption with Product with Serializable
68.  sealed abstract class StreamletOption extends OptionValue
69.  case class StreamletTechnologyOption(loc: At, args: Seq[Options.LiteralString]) extends StreamletOption with Product with Serializable
70.  case class TailRecursive(loc: At) extends FunctionOption with Product with Serializable

    A function option to mark a function as being tail recursive

    A function option to mark a function as being tail recursive

    loc

    The location of the tail recursive option

71.  trait WithOptions[T <: OptionValue] extends Definition

    Base trait that can be used in any definition that takes options and ensures the options are defined, can be queried, and formatted.

    Base trait that can be used in any definition that takes options and ensures the options are defined, can be queried, and formatted.

    T

    The sealed base trait of the permitted options for this definition

72.  case class WrapperOption(loc: At) extends ContextOption with Product with Serializable

    A context's "wrapper" option.

    A context's "wrapper" option. This option suggests the bounded context is to be used as a wrapper around an external system and is therefore at the boundary of the context map

    loc

    The location of the wrapper option