Packages

case class Function(loc: Location, id: Identifier, input: Option[Aggregation] = None, output: Option[Aggregation] = None, examples: Seq[Example] = Seq.empty[Example], brief: Option[LiteralString] = Option.empty[LiteralString], description: Option[Description] = None) extends ParentDefOf[Example] with EntityDefinition with ContextDefinition 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.

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

Instance Constructors

  1. new Function(loc: Location, id: Identifier, input: Option[Aggregation] = None, output: Option[Aggregation] = None, examples: Seq[Example] = Seq.empty[Example], brief: Option[LiteralString] = Option.empty[LiteralString], description: Option[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

  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
    FunctionBrieflyDescribedValue
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. lazy val contents: Seq[Example]
    Definition Classes
    FunctionContainer
  8. val description: Option[Description]
    Definition Classes
    FunctionDescribedValue
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val examples: Seq[Example]
  11. def format: String
    Definition Classes
    RiddlNode
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. val id: Identifier
    Definition Classes
    FunctionDefinition
  14. def identify: String
    Definition Classes
    Definition
  15. def identifyWithLoc: String
    Definition Classes
    Definition
  16. val input: Option[Aggregation]
  17. def isContainer: Boolean
    Definition Classes
    ContainerRiddlValue
  18. def isEmpty: Boolean
    Definition Classes
    FunctionContainerRiddlNode
  19. def isImplicit: Boolean
    Definition Classes
    Definition
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def isRootContainer: Boolean
    Definition Classes
    Container
  22. def kind: String
    Definition Classes
    Definition
  23. def kindId: String
    Definition Classes
    Definition
  24. val loc: Location
    Definition Classes
    FunctionRiddlValue
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def nonEmpty: Boolean
    Definition Classes
    RiddlNode
    Annotations
    @deprecatedOverriding()
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  29. val output: Option[Aggregation]
  30. def productElementNames: Iterator[String]
    Definition Classes
    Product
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. 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 ContextDefinition

Inherited from EntityDefinition

Inherited from ParentDefOf[Example]

Inherited from Container[Example]

Inherited from Definition

Inherited from BrieflyDescribedValue

Inherited from DescribedValue

Inherited from RiddlValue

Inherited from RiddlNode

Inherited from AnyRef

Inherited from Any

Ungrouped