Packages

case class Entity(loc: Location, id: Identifier, options: Seq[EntityOption] = Seq.empty[EntityOption], states: Seq[State] = Seq.empty[State], types: Seq[Type] = Seq.empty[Type], handlers: Seq[Handler] = Seq.empty[Handler], functions: Seq[Function] = Seq.empty[Function], invariants: Seq[Invariant] = Seq.empty[Invariant], includes: Seq[Include] = Seq.empty[Include], brief: Option[LiteralString] = Option.empty[LiteralString], description: Option[Description] = None) extends ParentDefOf[EntityDefinition] with ContextDefinition with OptionsDef[EntityOption] with WithIncludes with Product with Serializable

Definition of an Entity

loc

The location in the input

id

The name of the entity

options

The options for the entity

states

The state values of the entity

types

Type definitions useful internally to the entity definition

handlers

A set of event handlers

functions

Utility functions defined for the entity

invariants

Invariant properties of the entity

brief

A brief description (one sentence) for use in documentation

description

Optional description of the entity

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Entity
  2. Serializable
  3. Product
  4. Equals
  5. WithIncludes
  6. OptionsDef
  7. ContextDefinition
  8. ParentDefOf
  9. Container
  10. Definition
  11. BrieflyDescribedValue
  12. DescribedValue
  13. RiddlValue
  14. RiddlNode
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Entity(loc: Location, id: Identifier, options: Seq[EntityOption] = Seq.empty[EntityOption], states: Seq[State] = Seq.empty[State], types: Seq[Type] = Seq.empty[Type], handlers: Seq[Handler] = Seq.empty[Handler], functions: Seq[Function] = Seq.empty[Function], invariants: Seq[Invariant] = Seq.empty[Invariant], includes: Seq[Include] = Seq.empty[Include], brief: Option[LiteralString] = Option.empty[LiteralString], description: Option[Description] = None)

    loc

    The location in the input

    id

    The name of the entity

    options

    The options for the entity

    states

    The state values of the entity

    types

    Type definitions useful internally to the entity definition

    handlers

    A set of event handlers

    functions

    Utility functions defined for the entity

    invariants

    Invariant properties of the entity

    brief

    A brief description (one sentence) for use in documentation

    description

    Optional description of the entity

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
    EntityBrieflyDescribedValue
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. lazy val contents: Seq[EntityDefinition]
    Definition Classes
    EntityContainer
  8. val description: Option[Description]
    Definition Classes
    EntityDescribedValue
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def format: String
    Definition Classes
    OptionsDefRiddlNode
  11. val functions: Seq[Function]
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. val handlers: Seq[Handler]
  14. def hasOption[OPT <: EntityOption](implicit arg0: ClassTag[OPT]): Boolean
    Definition Classes
    OptionsDef
  15. val id: Identifier
    Definition Classes
    EntityDefinition
  16. def identify: String
    Definition Classes
    Definition
  17. def identifyWithLoc: String
    Definition Classes
    Definition
  18. val includes: Seq[Include]
    Definition Classes
    EntityWithIncludes
  19. val invariants: Seq[Invariant]
  20. def isContainer: Boolean
    Definition Classes
    ContainerRiddlValue
  21. def isEmpty: Boolean
    Definition Classes
    EntityOptionsDefContainerRiddlNode
  22. def isImplicit: Boolean
    Definition Classes
    Definition
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def isRootContainer: Boolean
    Definition Classes
    Container
  25. def kind: String
    Definition Classes
    Definition
  26. def kindId: String
    Definition Classes
    Definition
  27. val loc: Location
    Definition Classes
    EntityRiddlValue
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def nonEmpty: Boolean
    Definition Classes
    RiddlNode
    Annotations
    @deprecatedOverriding()
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  32. val options: Seq[EntityOption]
    Definition Classes
    EntityOptionsDef
  33. def productElementNames: Iterator[String]
    Definition Classes
    Product
  34. val states: Seq[State]
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. val types: Seq[Type]
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. 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 WithIncludes

Inherited from OptionsDef[EntityOption]

Inherited from ContextDefinition

Inherited from Container[EntityDefinition]

Inherited from Definition

Inherited from BrieflyDescribedValue

Inherited from DescribedValue

Inherited from RiddlValue

Inherited from RiddlNode

Inherited from AnyRef

Inherited from Any

Ungrouped