RIDDL
3.3.1
API
Generated with
RIDDL/com.reactific.riddl.language/AST/Invariant

Invariant

com.reactific.riddl.language.AST.Invariant
case class Invariant(loc: At, id: Identifier, condition: Option[LiteralString], brief: Option[LiteralString], description: Option[Description]) extends LeafDefinition, ProcessorDefinition, StateDefinition

An invariant expression that can be used in the definition of an entity. Invariants provide conditional expressions that must be true at all times in the lifecycle of an entity.

Value parameters

brief

A brief description (one sentence) for use in documentation

condition

The string representation of the condition that ought to be true

description

An optional description of the invariant.

id

The name of the invariant

loc

The location of the invariant definition

Attributes

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

Members list

Value members

Concrete methods

def format: String

Format the node to a string

Format the node to a string

Attributes

override def isEmpty: Boolean

determine if this node is empty or not.

determine if this node is empty or not. Non-containers are always empty

Attributes

Definition Classes

Inherited methods

def asVital[OPT <: OptionValue, DEF <: Definition]: VitalDefinition[OPT, DEF]

Attributes

Inherited from:
Definition
def briefValue: String

Attributes

Inherited from:
BrieflyDescribedValue
final def contents: Seq[Definition]

Attributes

Inherited from:
LeafDefinition
def descriptionValue: String

Attributes

Inherited from:
DescribedValue
def hasAuthors: Boolean

Attributes

Inherited from:
Definition
def hasBriefDescription: Boolean

Attributes

Inherited from:
BrieflyDescribedValue
override def hasDefinitions: Boolean

Attributes

Definition Classes
Inherited from:
Definition
def hasDescription: Boolean

Attributes

Inherited from:
DescribedValue
def hasOptions: Boolean

Attributes

Inherited from:
Definition
def hasTypes: Boolean

Attributes

Inherited from:
Definition
def identify: String

Attributes

Inherited from:
Definition
def identifyWithLoc: String

Attributes

Inherited from:
Definition
def isAppRelated: Boolean

Attributes

Inherited from:
Definition
override def isContainer: Boolean

Determine if this node is a container or not

Determine if this node is a container or not

Attributes

Definition Classes
Inherited from:
Container
override def isDefinition: Boolean

Attributes

Definition Classes
Inherited from:
Definition
def isImplicit: Boolean

Attributes

Inherited from:
Definition
def isRootContainer: Boolean

Attributes

Inherited from:
Container
def isVital: Boolean

Attributes

Inherited from:
Definition
final def nonEmpty: Boolean

Attributes

Inherited from:
RiddlNode
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def resolveNameTo(name: String): Option[Definition]

Attributes

Inherited from:
Definition

Concrete fields

final val kind: String
Generated with