LeafDefinition

com.ossuminc.riddl.language.AST.LeafDefinition
sealed trait LeafDefinition extends Definition, WithMetaData

A leaf node in the hierarchy of definitions. Leaves have no content, unlike Parent. They do permit a single BriefDescription value and single Description value. There are no contents.

Attributes

Source
AST.scala
Graph
Supertypes
trait WithMetaData
trait Definition
trait RiddlValue
class Object
trait Matchable
class Any
Show all
Known subtypes
class Field
class Method
class Author
class Connector
class Constant
class Invariant
trait Portlet
class Inlet
class Outlet
class Relationship
class SagaStep
class Schema
class State
class Term
class User
Show all

Members list

Value members

Inherited methods

A lazily constructed mutable Seq of AuthorRef

A lazily constructed mutable Seq of AuthorRef

Attributes

Inherited from:
WithMetaData
Source
AST.scala

AN optional BriefDescription

AN optional BriefDescription

Attributes

Inherited from:
WithMetaData
Source
AST.scala

A reliable extractor of the brief description, dealing with the optionality and plurality of it

A reliable extractor of the brief description, dealing with the optionality and plurality of it

Attributes

Inherited from:
WithMetaData
Source
AST.scala

A reliable extractor of the description, dealing with the optionality and plurality of it

A reliable extractor of the description, dealing with the optionality and plurality of it

Attributes

Inherited from:
WithMetaData
Source
AST.scala

A lazily constructed mutable.Seq of Description

A lazily constructed mutable.Seq of Description

Attributes

Inherited from:
WithMetaData
Source
AST.scala
override def hasAuthorRefs: Boolean

Determines if this RiddlValue references any Authors or not

Determines if this RiddlValue references any Authors or not

Attributes

Definition Classes
Inherited from:
WithMetaData
Source
AST.scala

Determines if this RiddlValuedefines any Authors or not

Determines if this RiddlValuedefines any Authors or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala
override def hasDefinitions: Boolean

Determine if this RiddlValue has definitions it contains

Determine if this RiddlValue has definitions it contains

Attributes

Definition Classes
Inherited from:
Definition
Source
AST.scala

Determines if this RiddlValue has any includes in it

Determines if this RiddlValue has any includes in it

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determines if this RiddlValue has any options set or not

Determines if this RiddlValue has any options set or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determines if this RiddlValue contains any type definitions

Determines if this RiddlValue contains any type definitions

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Convert the identifier into a string format with its kind and dealing with anonymity.

Convert the identifier into a string format with its kind and dealing with anonymity.

Attributes

Inherited from:
WithIdentifier
Source
AST.scala

Same as identify but also adds the value's location via loc

Same as identify but also adds the value's location via loc

Attributes

Inherited from:
WithIdentifier
Source
AST.scala
final inline override def isAnonymous: Boolean

This one has an identifier so it is only anonymous if that identifier is empty

This one has an identifier so it is only anonymous if that identifier is empty

Attributes

Definition Classes
Inherited from:
WithIdentifier
Source
AST.scala

Determines if this RiddlValue is a comment or not

Determines if this RiddlValue is a comment or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determine if this RiddlValue contains other values or not

Determine if this RiddlValue contains other values or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala
override def isDefinition: Boolean

Yes anything deriving from here is a definition

Yes anything deriving from here is a definition

Attributes

Definition Classes
Inherited from:
Definition
Source
AST.scala

Determine if this RiddlValue is empty or not.

Determine if this RiddlValue is empty or not. Non-containers are always empty

Attributes

Inherited from:
RiddlValue
Source
AST.scala
final inline override def isIdentified: Boolean

Whether or not this instance has an id: Identifier field or not

Whether or not this instance has an id: Identifier field or not

Attributes

Definition Classes
Inherited from:
WithIdentifier
Source
AST.scala
override def isParent: Boolean

Attributes

Definition Classes
Inherited from:
Definition
Source
AST.scala

Determines if this RiddlValue is a processor (handles messages) or not

Determines if this RiddlValue is a processor (handles messages) or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determine if this RiddlValue is the top most container, appearing at the root of the AST

Determine if this RiddlValue is the top most container, appearing at the root of the AST

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Determines if this node is a vital node or not

Determines if this node is a vital node or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala
def kind: String

Provide a string to specify the kind of thing this value is with default derived from class name

Provide a string to specify the kind of thing this value is with default derived from class name

Attributes

Inherited from:
RiddlValue
Source
AST.scala
final def nonEmpty: Boolean

implements the nonEmpty function based on the isEmpty function

implements the nonEmpty function based on the isEmpty function

Attributes

Inherited from:
RiddlValue
Source
AST.scala
def terms: Seq[Term]

A lazily constructed mutable Seq of AuthorRef

A lazily constructed mutable Seq of AuthorRef

Attributes

Inherited from:
WithMetaData
Source
AST.scala

Inherited and Abstract methods

def format: String

Format the node to a string in a form suitable for use in error messages

Format the node to a string in a form suitable for use in error messages

Attributes

Inherited from:
RiddlValue
Source
AST.scala
def id: Identifier

the name/identifier of this value.

the name/identifier of this value. All definitions have one

Attributes

Inherited from:
WithIdentifier
Source
AST.scala
def loc: At

The location in the parse at which this RiddlValue occurs

The location in the parse at which this RiddlValue occurs

Attributes

Inherited from:
RiddlValue
Source
AST.scala

Attributes

Inherited from:
WithMetaData
Source
AST.scala

Inherited fields

lazy val ulid: ULID

Attributes

Inherited from:
WithMetaData
Source
AST.scala