Options

com.reactific.riddl.language.ast.Options
trait Options

Option definitions for Vitals

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AST.type
Self type

Members list

Type members

Classlikes

sealed abstract class AdaptorOption(val name: String) extends OptionValue

Attributes

Supertypes
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
case class AdaptorTechnologyOption(loc: At, args: Seq[LiteralString]) extends AdaptorOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
sealed abstract class ApplicationOption(val name: String) extends OptionValue

Attributes

Supertypes
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
sealed abstract class ConnectorOption(val name: String) extends OptionValue

Attributes

Supertypes
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
case class ConnectorPersistentOption(loc: At) extends ConnectorOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class ConnectorTechnologyOption(loc: At, args: Seq[LiteralString]) extends ConnectorOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
sealed abstract class ContextOption(val name: String) extends OptionValue

Base trait for all options a Context can have.

Base trait for all options a Context can have.

Attributes

Supertypes
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
case class ContextPackageOption(loc: At, args: Seq[LiteralString]) extends ContextOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class ContextTechnologyOption(loc: At, args: Seq[LiteralString]) extends ContextOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class DomainExternalOption(loc: At) extends DomainOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class DomainOption
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
sealed abstract class DomainOption(val name: String) extends OptionValue

Base trait for all options a Domain can have.

Base trait for all options a Domain can have.

Attributes

Supertypes
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
case class DomainPackageOption(loc: At, args: Seq[LiteralString]) extends DomainOption

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

Value parameters

loc

The location of the wrapper option

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class DomainOption
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class DomainTechnologyOption(loc: At, args: Seq[LiteralString]) extends DomainOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class DomainOption
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class EntityEventSourced(loc: At) extends EntityOption

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.

Value parameters

loc

The location of the option.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class EntityOption
trait OptionValue
trait EntityValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class EntityIsAggregate(loc: At) extends EntityOption

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.

Value parameters

loc

The location of the option

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class EntityOption
trait OptionValue
trait EntityValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class EntityIsAvailable(loc: At) extends EntityOption

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.

Value parameters

loc

The location of the option.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class EntityOption
trait OptionValue
trait EntityValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class EntityIsConsistent(loc: At) extends EntityOption

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.

Value parameters

loc

The location of the option.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class EntityOption
trait OptionValue
trait EntityValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class EntityIsDevice(loc: At) extends EntityOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class EntityOption
trait OptionValue
trait EntityValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class EntityIsFiniteStateMachine(loc: At) extends EntityOption

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.

Value parameters

loc

The location of the option.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class EntityOption
trait OptionValue
trait EntityValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class EntityKind(loc: At, args: Seq[LiteralString]) extends EntityOption

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", "user", "concept", "machine", and similar kinds of entities. This entity option may be used by downstream AST processors, especially code generators.

Value parameters

args

The argument to the option

loc

The location of the entity kind option

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class EntityOption
trait OptionValue
trait EntityValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class EntityMessageQueue(loc: At) extends EntityOption

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.

Value parameters

loc

The location at which this option occurs.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class EntityOption
trait OptionValue
trait EntityValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
sealed abstract class EntityOption(val name: String) extends EntityValue, OptionValue

Abstract base class of options for entities

Abstract base class of options for entities

Value parameters

name

the name of the option

Attributes

Supertypes
trait OptionValue
trait EntityValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
case class EntityTechnologyOption(loc: At, args: Seq[LiteralString]) extends EntityOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class EntityOption
trait OptionValue
trait EntityValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class EntityTransient(loc: At) extends EntityOption

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.

Value parameters

loc

The location of the option.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class EntityOption
trait OptionValue
trait EntityValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
sealed trait EntityValue extends RiddlValue

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

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

Attributes

Supertypes
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Known subtypes
case class EntityValueOption(loc: At) extends EntityOption

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.

Value parameters

loc

The location of the option

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class EntityOption
trait OptionValue
trait EntityValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
sealed abstract class EpicOption(val name: String) extends OptionValue

Attributes

Supertypes
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
case class EpicSynchronousOption(loc: At) extends EpicOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class EpicOption
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class EpicTechnologyOption(loc: At, args: Seq[LiteralString]) extends EpicOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class EpicOption
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
sealed abstract class FunctionOption(val name: String) extends OptionValue

Base class of all function options

Base class of all function options

Value parameters

name

The name of the option

Attributes

Supertypes
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
case class GatewayOption(loc: At) extends ContextOption

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.

Value parameters

loc

The location of the gateway option

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
sealed abstract class HandlerOption(val name: String) extends OptionValue

Attributes

Supertypes
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
case class ParallelOption(loc: At) extends SagaOption

A SagaOption that indicates parallel execution of the saga actions.

A SagaOption that indicates parallel execution of the saga actions.

Value parameters

loc

The location of the parallel option

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class SagaOption
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class PartialHandlerOption(loc: At) extends HandlerOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
sealed abstract class ProjectorOption(val name: String) extends OptionValue

Attributes

Supertypes
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
case class ProjectorTechnologyOption(loc: At, args: Seq[LiteralString]) extends ProjectorOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
sealed abstract class RepositoryOption(val name: String) extends OptionValue

Attributes

Supertypes
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
sealed abstract class SagaOption(val name: String) extends OptionValue

Base trait for all options applicable to a saga.

Base trait for all options applicable to a saga.

Attributes

Supertypes
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
case class SagaTechnologyOption(loc: At, args: Seq[LiteralString]) extends SagaOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class SagaOption
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class SequentialOption(loc: At) extends SagaOption

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

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

Value parameters

loc

The location of the sequential option

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class SagaOption
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class ServiceOption(loc: At) extends ContextOption

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

Value parameters

loc

The location at which the option occurs

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
sealed abstract class StreamletOption(val name: String) extends OptionValue

Attributes

Supertypes
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
case class StreamletTechnologyOption(loc: At, args: Seq[LiteralString]) extends StreamletOption

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
case class TailRecursive(loc: At) extends FunctionOption

A function option to mark a function as being tail recursive

A function option to mark a function as being tail recursive

Value parameters

loc

The location of the tail recursive option

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
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.

Type parameters

T

The sealed base trait of the permitted options for this definition

Attributes

Supertypes
trait Definition
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
class Connector
trait VitalDefinition[OPT, DEF]
class Domain
class Epic
class Function
trait Processor[OPT, DEF]
class Adaptor
class Application
class Context
class Entity
class Projector
class Repository
class Streamlet
class Saga
Show all
case class WrapperOption(loc: At) extends ContextOption

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

Value parameters

loc

The location of the wrapper option

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait OptionValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all