Packages

case class Invariant(loc: Location, id: Identifier, expression: Condition, brief: Option[LiteralString] = Option.empty[LiteralString], description: Option[Description] = None) extends 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.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Invariant
  2. Serializable
  3. Product
  4. Equals
  5. EntityDefinition
  6. Definition
  7. BrieflyDescribedValue
  8. DescribedValue
  9. RiddlValue
  10. RiddlNode
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Invariant(loc: Location, id: Identifier, expression: Condition, brief: Option[LiteralString] = Option.empty[LiteralString], description: Option[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[LiteralString]
    Definition Classes
    InvariantBrieflyDescribedValue
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. val description: Option[Description]
    Definition Classes
    InvariantDescribedValue
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. val expression: Condition
  10. def format: String
    Definition Classes
    RiddlNode
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. val id: Identifier
    Definition Classes
    InvariantDefinition
  13. def identify: String
    Definition Classes
    Definition
  14. def identifyWithLoc: String
    Definition Classes
    Definition
  15. def isContainer: Boolean
    Definition Classes
    RiddlValue
  16. def isEmpty: Boolean
    Definition Classes
    InvariantRiddlNode
  17. def isImplicit: Boolean
    Definition Classes
    Definition
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def kind: String
    Definition Classes
    Definition
  20. def kindId: String
    Definition Classes
    Definition
  21. val loc: Location
    Definition Classes
    InvariantRiddlValue
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def nonEmpty: Boolean
    Definition Classes
    RiddlNode
    Annotations
    @deprecatedOverriding()
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  26. def productElementNames: Iterator[String]
    Definition Classes
    Product
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. 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 EntityDefinition

Inherited from Definition

Inherited from BrieflyDescribedValue

Inherited from DescribedValue

Inherited from RiddlValue

Inherited from RiddlNode

Inherited from AnyRef

Inherited from Any

Ungrouped