RIDDL
3.3.1
API
Generated with
RIDDL/com.reactific.riddl.language/com.reactific.riddl.language.ast/AbstractDefinitions

AbstractDefinitions

com.reactific.riddl.language.ast.AbstractDefinitions
trait AbstractDefinitions

Attributes

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

Members list

Type members

Classlikes

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.

Attributes

Supertypes
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
trait AlwaysEmpty extends Definition

Attributes

Supertypes
trait Definition
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
class Inlet
class Outlet
class Field
case class BlockDescription(loc: At, lines: Seq[LiteralString]) extends Description

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Description
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
trait BrieflyDescribedValue extends RiddlValue

Attributes

Supertypes
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Known subtypes
trait Definition
trait AlwaysEmpty
class Inlet
class Outlet
class Field
class Function
class Type
class Include[T]
class Term
class Author
class Connector
class Constant
class Invariant
trait OnClause
class OnInitClause
class Replica
class SagaStep
class User
class Enumerator
class Handler
trait Interaction
trait UIElement
class Group
class Input
class Output
class Adaptor
class Entity
class Projector
class Repository
class Saga
class Streamlet
class Application
class Context
class Domain
class Epic
class State
class UseCase
trait Portlet
trait VitalDefinition[OPT, DEF]
trait Processor[OPT, DEF]
trait WithAuthors
trait WithTypes
trait WithOptions[T]
Show all
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

Type parameters

D

The kind of definition that is contained by the container

Attributes

Supertypes
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Known subtypes
trait Definition
trait AlwaysEmpty
class Inlet
class Outlet
class Field
class Function
class Type
class Include[T]
class Term
class Author
class Connector
class Constant
class Invariant
trait OnClause
class OnInitClause
class Replica
class SagaStep
class User
class Enumerator
class Handler
trait Interaction
trait UIElement
class Group
class Input
class Output
class Adaptor
class Entity
class Projector
class Repository
class Saga
class Streamlet
class Application
class Context
class Domain
class Epic
class State
class UseCase
trait Portlet
trait VitalDefinition[OPT, DEF]
trait Processor[OPT, DEF]
trait WithAuthors
trait WithTypes
trait WithOptions[T]
trait WithIncludes[T]
class Aggregation
Show all
trait Definition extends DescribedValue, BrieflyDescribedValue, 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

Attributes

Supertypes
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
trait AlwaysEmpty
class Inlet
class Outlet
class Field
class Function
class Type
class Include[T]
class Term
class Author
class Connector
class Constant
class Invariant
trait OnClause
class OnInitClause
class Replica
class SagaStep
class User
class Enumerator
class Handler
trait Interaction
trait UIElement
class Group
class Input
class Output
class Adaptor
class Entity
class Projector
class Repository
class Saga
class Streamlet
class Application
class Context
class Domain
class Epic
class State
class UseCase
trait Portlet
trait VitalDefinition[OPT, DEF]
trait Processor[OPT, DEF]
trait WithAuthors
trait WithTypes
trait WithOptions[T]
Show all
trait DescribedValue extends RiddlValue

Base trait of all values that have an optional Description

Base trait of all values that have an optional Description

Attributes

Supertypes
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Known subtypes
trait Definition
trait AlwaysEmpty
class Inlet
class Outlet
class Field
class Function
class Type
class Include[T]
class Term
class Author
class Connector
class Constant
class Invariant
trait OnClause
class OnInitClause
class Replica
class SagaStep
class User
class Enumerator
class Handler
trait Interaction
trait UIElement
class Group
class Input
class Output
class Adaptor
class Entity
class Projector
class Repository
class Saga
class Streamlet
class Application
class Context
class Domain
class Epic
class State
class UseCase
trait Portlet
trait VitalDefinition[OPT, DEF]
trait Processor[OPT, DEF]
trait WithAuthors
trait WithTypes
trait WithOptions[T]
Show all
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.

Attributes

Supertypes
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Known subtypes
case class FileDescription(loc: At, file: Path) extends Description

Attributes

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

Attributes

Supertypes
trait Definition
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
class Function
class Type
class Include[T]
class Term
class Field
Show all
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)

Attributes

Supertypes
trait GherkinValue
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
trait GherkinValue extends RiddlValue

Base class of any Gherkin value

Base class of any Gherkin value

Attributes

Supertypes
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Known subtypes
case class Identifier(loc: At, value: String) extends RiddlValue

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.

Value parameters

loc

The location in the input where the identifier starts

value

The parsed value of the identifier

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
object Identifier

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Identifier.type
trait LeafDefinition extends Definition

Attributes

Supertypes
trait Definition
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
class Author
class Connector
class Constant
class Inlet
class Invariant
trait OnClause
class OnInitClause
class Outlet
class Replica
class SagaStep
class Term
class User
class Enumerator
class Field
Show all
case class LiteralString(loc: At, s: String) extends RiddlValue

Represents a literal string parsed between quote characters in the input

Represents a literal string parsed between quote characters in the input

Value parameters

loc

The location in the input of the opening quote character

s

The parsed value of the string content

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
object LiteralString

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class PathIdentifier(loc: At, value: Seq[String]) extends RiddlValue

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.

Value parameters

loc

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

value

The list of strings that make up the path identifier

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
object PathIdentifier

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait ProjectorDefinition extends Definition

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

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

Attributes

Supertypes
trait Definition
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
class Function
class Handler
class Invariant
class Constant
class Inlet
class Outlet
class Type
class Include[T]
class Term
class Field
Show all
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.

Type parameters

T

The type of definition to which the references refers.

Attributes

Supertypes
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Known subtypes
class AuthorRef
class ConstantRef
class DomainRef
class EpicRef
class FieldRef
class FunctionRef
class GroupRef
class HandlerRef
class InputRef
trait MessageRef
class CommandRef
class EventRef
class QueryRef
class RecordRef
class ResultRef
class OutputRef
trait PortletRef[T]
class InletRef
class OutletRef
trait ProcessorRef[T]
class AdaptorRef
class ContextRef
class EntityRef
class ProjectorRef
class StreamletRef
class SagaRef
class StateRef
class TypeRef
class UserRef
Show all
trait RiddlNode

The root trait of all things RIDDL AST.

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait RiddlValue
trait Action
trait Definition
trait AlwaysEmpty
class Inlet
class Outlet
class Field
class Function
class Type
class Include[T]
class Term
class Author
class Connector
class Constant
class Invariant
trait OnClause
class OnInitClause
class Replica
class SagaStep
class User
class Enumerator
class Handler
trait Interaction
trait UIElement
class Group
class Input
class Output
class Adaptor
class Entity
class Projector
class Repository
class Saga
class Streamlet
class Application
class Context
class Domain
class Epic
class State
class UseCase
trait Portlet
trait VitalDefinition[OPT, DEF]
trait Processor[OPT, DEF]
trait WithAuthors
trait WithTypes
trait WithOptions[T]
trait Container[D]
trait WithIncludes[T]
class Aggregation
trait Description
trait GherkinValue
class Identifier
class Reference[T]
class AuthorRef
class ConstantRef
class DomainRef
class EpicRef
class FieldRef
class FunctionRef
class GroupRef
class HandlerRef
class InputRef
trait MessageRef
class CommandRef
class EventRef
class QueryRef
class RecordRef
class ResultRef
class OutputRef
trait PortletRef[T]
class InletRef
class OutletRef
trait ProcessorRef[T]
class AdaptorRef
class ContextRef
class EntityRef
class ProjectorRef
class StreamletRef
class SagaRef
class StateRef
class TypeRef
class UserRef
class Flow
class Merge
class Router
class Sink
class Source
class Split
class Void
class UserStory
trait EntityValue
class EntityOption
class EntityKind
trait OptionValue
class DomainOption
class EpicOption
class SagaOption
trait Statement
class SetStatement
class Alternation
trait Cardinality
class OneOrMore
class Optional
class ZeroOrMore
class Mapping
trait NumericType
class Bool
class Enumeration
class Integer
class Natural
class Number
class RangeType
class Whole
class Current
class Decimal
class Length
class Luminosity
class Mass
class Mole
class Real
class Temperature
class Abstract
class Currency
class Location
class Nothing
class Pattern
class Strng
trait TimeType
class Date
class DateTime
class Duration
class Time
class TimeStamp
class URL
class UUID
class UniqueId
class UnknownType
class Sequence
class Set
Show all
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.

Attributes

Supertypes
trait RiddlNode
class Object
trait Matchable
class Any
Known subtypes
trait Action
trait Definition
trait AlwaysEmpty
class Inlet
class Outlet
class Field
class Function
class Type
class Include[T]
class Term
class Author
class Connector
class Constant
class Invariant
trait OnClause
class OnInitClause
class Replica
class SagaStep
class User
class Enumerator
class Handler
trait Interaction
trait UIElement
class Group
class Input
class Output
class Adaptor
class Entity
class Projector
class Repository
class Saga
class Streamlet
class Application
class Context
class Domain
class Epic
class State
class UseCase
trait Portlet
trait VitalDefinition[OPT, DEF]
trait Processor[OPT, DEF]
trait WithAuthors
trait WithTypes
trait WithOptions[T]
trait Container[D]
trait WithIncludes[T]
class Aggregation
trait Description
trait GherkinValue
class Identifier
class Reference[T]
class AuthorRef
class ConstantRef
class DomainRef
class EpicRef
class FieldRef
class FunctionRef
class GroupRef
class HandlerRef
class InputRef
trait MessageRef
class CommandRef
class EventRef
class QueryRef
class RecordRef
class ResultRef
class OutputRef
trait PortletRef[T]
class InletRef
class OutletRef
trait ProcessorRef[T]
class AdaptorRef
class ContextRef
class EntityRef
class ProjectorRef
class StreamletRef
class SagaRef
class StateRef
class TypeRef
class UserRef
class Flow
class Merge
class Router
class Sink
class Source
class Split
class Void
class UserStory
trait EntityValue
class EntityOption
class EntityKind
trait OptionValue
class DomainOption
class EpicOption
class SagaOption
trait Statement
class SetStatement
class Alternation
trait Cardinality
class OneOrMore
class Optional
class ZeroOrMore
class Mapping
trait NumericType
class Bool
class Enumeration
class Integer
class Natural
class Number
class RangeType
class Whole
class Current
class Decimal
class Length
class Luminosity
class Mass
class Mole
class Real
class Temperature
class Abstract
class Currency
class Location
class Nothing
class Pattern
class Strng
trait TimeType
class Date
class DateTime
class Duration
class Time
class TimeStamp
class URL
class UUID
class UniqueId
class UnknownType
class Sequence
class Set
Show all
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

Attributes

Supertypes
trait Definition
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
class Function
class Constant
class Inlet
class Outlet
class Type
class SagaStep
class Include[T]
class Term
class Field
Show all
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

Attributes

Supertypes
trait Definition
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
class Handler
class Invariant
class Type
class Field
case class URLDescription(loc: At, url: URL) extends Description

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Description
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
trait UseCaseDefinition extends Definition

Base trait of definitions in a UseCase, typically interactions

Base trait of definitions in a UseCase, typically interactions

Attributes

Supertypes
trait Definition
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Interaction
Show all
Generated with