case class OnMessageClause(loc: At, msg: MessageRef, from: Option[Definitions.Reference[Definitions.Definition]], examples: Seq[Example] = Seq.empty[Example], brief: Option[Definitions.LiteralString] = Option.empty[LiteralString], description: Option[Definitions.Description] = None) extends OnClause with Product with Serializable
Defines the actions to be taken when a particular message is received by an entity. OnMessageClauses 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
- from
Optional message generating
- 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
Ordering
- Alphabetic
- By Inheritance
Inherited
- OnMessageClause
- Serializable
- Product
- Equals
- OnClause
- HandlerDefinition
- Definition
- Container
- BrieflyDescribedValue
- DescribedValue
- RiddlValue
- RiddlNode
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new OnMessageClause(loc: At, msg: MessageRef, from: Option[Definitions.Reference[Definitions.Definition]], examples: Seq[Example] = Seq.empty[Example], brief: Option[Definitions.LiteralString] = Option.empty[LiteralString], description: Option[Definitions.Description] = None)
- loc
The location of the "on" clause
- msg
A reference to the message type that is handled
- from
Optional message generating
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val brief: Option[Definitions.LiteralString]
- Definition Classes
- OnMessageClause → BrieflyDescribedValue
- def briefValue: String
- Definition Classes
- BrieflyDescribedValue
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def contents: Seq[Example]
- Definition Classes
- OnMessageClause → Container
- val description: Option[Definitions.Description]
- Definition Classes
- OnMessageClause → DescribedValue
- def descriptionValue: String
- Definition Classes
- DescribedValue
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val examples: Seq[Example]
- Definition Classes
- OnMessageClause → OnClause
- def find(name: String): Option[Definitions.Definition]
- Definition Classes
- Definition
- def format: String
Format the node to a string
Format the node to a string
- Definition Classes
- OnMessageClause → RiddlNode
- val from: Option[Definitions.Reference[Definitions.Definition]]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hasAuthors: Boolean
- Definition Classes
- Definition
- def hasOptions: Boolean
- Definition Classes
- Definition
- def hasTypes: Boolean
- Definition Classes
- Definition
- def id: Definitions.Identifier
- Definition Classes
- OnMessageClause → Definition
- def identify: String
- Definition Classes
- Definition
- def identifyWithLoc: String
- Definition Classes
- Definition
- def isContainer: Boolean
Determine if this node is a container or not
- 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
- OnMessageClause → Container → RiddlNode
- def isImplicit: Boolean
- Definition Classes
- Definition
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isRootContainer: Boolean
- Definition Classes
- Container
- def isVital: Boolean
- Definition Classes
- Definition
- final val kind: String
- Definition Classes
- OnMessageClause → Definition
- val loc: At
The location in the parse at which this RiddlValue occurs
The location in the parse at which this RiddlValue occurs
- Definition Classes
- OnMessageClause → RiddlValue
- val msg: MessageRef
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def nonEmpty: Boolean
- Definition Classes
- RiddlNode
- Annotations
- @deprecatedOverriding()
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated