Packages

case class OnClause(loc: Location, msg: MessageRef, examples: Seq[Example] = Seq.empty[Example], brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None) extends HandlerDefinition with Product with Serializable

Defines the actions to be taken when a particular message is received by an entity. OnClauses are used in the definition of a Handler with one for each kind of message that handler deals with.

loc

The location of the "on" clause

msg

A reference to the message type that is handled

examples

A set of examples that define the behavior when the msg is received.

brief

A brief description (one sentence) for use in documentation

description

An optional description of the on clause.

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

Instance Constructors

  1. new OnClause(loc: Location, msg: MessageRef, examples: Seq[Example] = Seq.empty[Example], brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None)

    loc

    The location of the "on" clause

    msg

    A reference to the message type that is handled

    examples

    A set of examples that define the behavior when the msg is received.

    brief

    A brief description (one sentence) for use in documentation

    description

    An optional description of the on clause.

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
    OnClause → BrieflyDescribedValue
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def contents: Seq[Example]
    Definition Classes
    OnClause → Container
  8. val description: Option[AST.Description]
    Definition Classes
    OnClause → DescribedValue
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val examples: Seq[Example]
  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. def id: AST.Identifier
    Definition Classes
    OnClause → 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
    OnClause → 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
    OnClause → 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
    OnClause → RiddlValue
  27. val msg: MessageRef
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final 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. def productElementNames: Iterator[String]
    Definition Classes
    Product
  33. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. 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.HandlerDefinition

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