Packages

case class Invariant(loc: Location, id: AST.Identifier, expression: Option[AST.Condition] = None, brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None) extends LeafDefinition with EntityDefinition with Product with Serializable

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.

loc

The location of the invariant definition

id

The name of the invariant

expression

The conditional expression that must always be true.

brief

A brief description (one sentence) for use in documentation

description

An optional description of the invariant.

Linear Supertypes
Serializable, Product, Equals, AST.EntityDefinition, AST.LeafDefinition, AST.Definition, AST.Container[AST.Definition], AST.BrieflyDescribedValue, AST.DescribedValue, AST.RiddlValue, AST.RiddlNode, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Invariant
  2. Serializable
  3. Product
  4. Equals
  5. EntityDefinition
  6. LeafDefinition
  7. Definition
  8. Container
  9. BrieflyDescribedValue
  10. DescribedValue
  11. RiddlValue
  12. RiddlNode
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Invariant(loc: Location, id: AST.Identifier, expression: Option[AST.Condition] = None, brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None)

    loc

    The location of the invariant definition

    id

    The name of the invariant

    expression

    The conditional expression that must always be true.

    brief

    A brief description (one sentence) for use in documentation

    description

    An optional description of the invariant.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val brief: Option[AST.LiteralString]
    Definition Classes
    Invariant → BrieflyDescribedValue
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. final def contents: Seq[AST.Definition]
    Definition Classes
    LeafDefinition → Container
  8. val description: Option[AST.Description]
    Definition Classes
    Invariant → DescribedValue
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val expression: Option[AST.Condition]
  11. def format: String

    Format the node to a string

    Format the node to a string

    Definition Classes
    RiddlNode
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def hasAuthors: Boolean
    Definition Classes
    Definition
  14. def hasOptions: Boolean
    Definition Classes
    Definition
  15. def hasTypes: Boolean
    Definition Classes
    Definition
  16. val id: AST.Identifier
    Definition Classes
    Invariant → Definition
  17. def identify: String
    Definition Classes
    Definition
  18. def identifyWithLoc: String
    Definition Classes
    Definition
  19. def isContainer: Boolean

    Determine if this node is a container or not

    Determine if this node is a container or not

    Definition Classes
    Container → RiddlNode
  20. def isEmpty: Boolean

    determine if this node is empty or not.

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

    Definition Classes
    Invariant → LeafDefinition → Container → RiddlNode
  21. def isImplicit: Boolean
    Definition Classes
    Definition
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def isRootContainer: Boolean
    Definition Classes
    Container
  24. final val kind: String
    Definition Classes
    Invariant → Definition
  25. def kindId: String
    Definition Classes
    Definition
  26. val loc: Location

    The location in the parse at which this RiddlValue occurs

    The location in the parse at which this RiddlValue occurs

    Definition Classes
    Invariant → RiddlValue
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def nonEmpty: Boolean
    Definition Classes
    RiddlNode
    Annotations
    @deprecatedOverriding()
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. def productElementNames: Iterator[String]
    Definition Classes
    Product
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AST.EntityDefinition

Inherited from AST.LeafDefinition

Inherited from AST.Definition

Inherited from AST.Container[AST.Definition]

Inherited from AST.BrieflyDescribedValue

Inherited from AST.DescribedValue

Inherited from AST.RiddlValue

Inherited from AST.RiddlNode

Inherited from AnyRef

Inherited from Any

Ungrouped