RIDDL
3.4.3
API
Generated with
RIDDL/com.ossuminc.riddl.language/AST/State

State

com.ossuminc.riddl.language.AST.State
case class State(loc: At, id: Identifier, typ: TypeRef, metadata: Contents[MetaData]) extends Leaf

Represents a state of an entity. A State defines the shape of the entity's state when it is active. The MorphAction can cause the active state of an entity to change. Consequently the state of an entity can change its value (mutable) and they shape of that value.

Value parameters

brief

A brief description (one sentence) for use in documentation

description

An optional description of the state.

id

The name of the state definition

loc

The location of the state definition

typ

A reference to a type definition that provides the range of values that the state may assume.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Leaf
trait WithMetaData
trait Definition
trait RiddlValue
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete 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 methods

def authorRefs: Seq[AuthorRef]

A lazily constructed mutable Seq of AuthorRef

A lazily constructed mutable Seq of AuthorRef

Attributes

Inherited from:
WithMetaData
def brief: Option[BriefDescription]

AN optional BriefDescription

AN optional BriefDescription

Attributes

Inherited from:
WithMetaData
def briefString: String

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
def descriptionString: String

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
def descriptions: Seq[Description]

A lazily constructed scala.Seq of Description

A lazily constructed scala.Seq of Description

Attributes

Inherited from:
WithMetaData
def errorLoc: At

Attributes

Inherited from:
WithIdentifier
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
def hasAuthors: Boolean

Determines if this RiddlValuedefines any Authors or not

Determines if this RiddlValuedefines any Authors or not

Attributes

Inherited from:
RiddlValue
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
def hasIncludes: Boolean

Determines if this RiddlValue has any includes in it

Determines if this RiddlValue has any includes in it

Attributes

Inherited from:
RiddlValue
def hasOptions: Boolean

Determines if this RiddlValue has any options set or not

Determines if this RiddlValue has any options set or not

Attributes

Inherited from:
RiddlValue
def hasTypes: Boolean

Determines if this RiddlValue contains any type definitions

Determines if this RiddlValue contains any type definitions

Attributes

Inherited from:
RiddlValue
def identify: String

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
def identifyWithLoc: String

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
final 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
def isComment: Boolean

Determines if this RiddlValue is a comment or not

Determines if this RiddlValue is a comment or not

Attributes

Inherited from:
RiddlValue
def isContainer: Boolean

Determine if this RiddlValue contains other values or not

Determine if this RiddlValue contains other values or not

Attributes

Inherited from:
RiddlValue
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
def isEmpty: Boolean

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
final 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
override def isParent: Boolean

Attributes

Definition Classes
Inherited from:
Definition
def isProcessor: Boolean

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
def isRootContainer: Boolean

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
def isVital: Boolean

Determines if this node is a vital node or not

Determines if this node is a vital node or not

Attributes

Inherited from:
RiddlValue
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
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
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def terms: Seq[Term]

A lazily constructed mutable Seq of AuthorRef

A lazily constructed mutable Seq of AuthorRef

Attributes

Inherited from:
WithMetaData

Inherited fields

lazy val ulid: ULID

Attributes

Inherited from:
WithMetaData
Generated with