case class Function(loc: Location, id: AST.Identifier, input: Option[AST.Aggregation] = None, output: Option[AST.Aggregation] = None, types: Seq[Type] = Seq.empty[Type], functions: Seq[Function] = Seq.empty[Function], examples: Seq[Example] = Seq.empty[Example], brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None) extends EntityDefinition with WithTypes with ContextDefinition with FunctionDefinition with Product with Serializable
A function definition which can be part of a bounded context or an entity.
- loc
The location of the function definition
- id
The identifier that names the function
- input
An optional type expression that names and types the fields of the input of the function
- output
An optional type expression that names and types the fields of the output of the function
- examples
The set of examples that define the behavior of the function.
- brief
A brief description (one sentence) for use in documentation
- description
An optional description of the function.
- Alphabetic
- By Inheritance
- Function
- Serializable
- Product
- Equals
- FunctionDefinition
- ContextDefinition
- WithTypes
- EntityDefinition
- Definition
- Container
- BrieflyDescribedValue
- DescribedValue
- RiddlValue
- RiddlNode
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Function(loc: Location, id: AST.Identifier, input: Option[AST.Aggregation] = None, output: Option[AST.Aggregation] = None, types: Seq[Type] = Seq.empty[Type], functions: Seq[Function] = Seq.empty[Function], examples: Seq[Example] = Seq.empty[Example], brief: Option[AST.LiteralString] = Option.empty[LiteralString], description: Option[AST.Description] = None)
- loc
The location of the function definition
- id
The identifier that names the function
- input
An optional type expression that names and types the fields of the input of the function
- output
An optional type expression that names and types the fields of the output of the function
- examples
The set of examples that define the behavior of the function.
- brief
A brief description (one sentence) for use in documentation
- description
An optional description of the function.
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[AST.LiteralString]
- Definition Classes
- Function → BrieflyDescribedValue
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- lazy val contents: Seq[AST.FunctionDefinition]
- val description: Option[AST.Description]
- Definition Classes
- Function → DescribedValue
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val examples: Seq[Example]
- def format: String
Format the node to a string
Format the node to a string
- Definition Classes
- RiddlNode
- val functions: Seq[Function]
- 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
- WithTypes → Definition
- val id: AST.Identifier
- Definition Classes
- Function → Definition
- def identify: String
- Definition Classes
- Definition
- def identifyWithLoc: String
- Definition Classes
- Definition
- val input: Option[AST.Aggregation]
- def isContainer: Boolean
Determine if this node is a container or not
- def isEmpty: Boolean
determine if this node is empty or not.
- def isImplicit: Boolean
- Definition Classes
- Definition
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isRootContainer: Boolean
- Definition Classes
- Container
- final val kind: String
- Definition Classes
- Function → Definition
- def kindId: String
- Definition Classes
- Definition
- 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
- Function → RiddlValue
- 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()
- val output: Option[AST.Aggregation]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val types: Seq[Type]
- 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