RIDDL API Documentation
0.0.0-1-1f99f002
API
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.
RIDDL API Documentation/com.ossuminc.riddl/com.ossuminc.riddl.language/AST/Function

Function

com.ossuminc.riddl.language.AST.Function
case class Function(loc: At, id: Identifier, input: Option[Aggregation], output: Option[Aggregation], contents: ArrayBuffer[FunctionContents], metadata: ArrayBuffer[MetaData]) extends VitalDefinition[FunctionContents], WithTypes[FunctionContents], WithFunctions[FunctionContents], WithStatements[FunctionContents]

A function definition which can be part of a bounded context or an entity.

Value parameters

contents

The set of types, functions, statements, authors, includes and terms that define this FUnction

id

The identifier that names the function

input

An optional type expression that names and types the fields of the input of the function

loc

The location of the function definition

metadata

The set of descriptive values for this function

output

An optional type expression that names and types the fields of the output of the function

Attributes

Source
AST.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait WithMetaData
trait Parent
trait Definition
trait RiddlValue
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def format: String

Format the node to a string in a form suitable for use in error messages

Format the node to a string in a form suitable for use in error messages

Attributes

Definition Classes
Source
AST.scala
override def isEmpty: Boolean

Determine if this RiddlValue is empty or not.

Determine if this RiddlValue is empty or not. Non-containers are always empty

Attributes

Definition Classes
Source
AST.scala
final inline override def kind: String

Provide a string to specify the kind of thing this value is with default derived from class name

Provide a string to specify the kind of thing this value is with default derived from class name

Attributes

Definition Classes
Source
AST.scala

Inherited methods

def authorRefs: Seq[AuthorRef]

A lazily constructed mutable Seq of AuthorRef

A lazily constructed mutable Seq of AuthorRef

Attributes

Inherited from:
WithMetaData
Source
AST.scala
def brief: Option[BriefDescription]

AN optional BriefDescription

AN optional BriefDescription

Attributes

Inherited from:
WithMetaData
Source
AST.scala
def briefString: String

A reliable extractor of the brief description, dealing with the optionality and plurality of it

A reliable extractor of the brief description, dealing with the optionality and plurality of it

Attributes

Inherited from:
WithMetaData
Source
AST.scala
def comments: Seq[Comment]

A lazily constructed Seq of Comment filtered from the contents

A lazily constructed Seq of Comment filtered from the contents

Attributes

Inherited from:
WithComments
Source
AST.scala
def descriptionString: String

A reliable extractor of the description, dealing with the optionality and plurality of it

A reliable extractor of the description, dealing with the optionality and plurality of it

Attributes

Inherited from:
WithMetaData
Source
AST.scala
def descriptions: Seq[Description]

A lazily constructed scala.Seq of Description

A lazily constructed scala.Seq of Description

Attributes

Inherited from:
WithMetaData
Source
AST.scala
def functions: Seq[Function]

A lazily constructed Seq of Function filtered from the contents

A lazily constructed Seq of Function filtered from the contents

Attributes

Inherited from:
WithFunctions
Source
AST.scala
def getOptionValue(name: String): Option[OptionValue]

Get the value of name'd option, if there is one.

Get the value of name'd option, if there is one.

Attributes

Inherited from:
WithOptions
Source
AST.scala
override def hasAuthorRefs: Boolean

Determines if this RiddlValue references any Authors or not

Determines if this RiddlValue references any Authors or not

Attributes

Definition Classes
Inherited from:
WithMetaData
Source
AST.scala
def hasAuthors: Boolean

Determines if this RiddlValuedefines any Authors or not

Determines if this RiddlValuedefines any Authors or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala
override def hasDefinitions: Boolean

True iff there are contained definitions

True iff there are contained definitions

Attributes

Definition Classes
Inherited from:
Parent
Source
AST.scala
final override def hasIncludes: Boolean

Determines if this RiddlValue has any includes in it

Determines if this RiddlValue has any includes in it

Attributes

Definition Classes
Inherited from:
WithIncludes
Source
AST.scala
def hasOption(name: String): Boolean

True if this value contains an option with the given name.

True if this value contains an option with the given name.

Attributes

Inherited from:
WithOptions
Source
AST.scala
override def hasOptions: Boolean

Determines if this RiddlValue has any options set or not

Determines if this RiddlValue has any options set or not

Attributes

Definition Classes
Inherited from:
WithOptions
Source
AST.scala
override def hasTypes: Boolean

Determines if this RiddlValue contains any type definitions

Determines if this RiddlValue contains any type definitions

Attributes

Definition Classes
Inherited from:
WithTypes
Source
AST.scala
def identify: String

Convert the identifier into a string format with its kind and dealing with anonymity.

Convert the identifier into a string format with its kind and dealing with anonymity.

Attributes

Inherited from:
WithIdentifier
Source
AST.scala
def identifyWithLoc: String

Same as identify but also adds the value's location via loc

Same as identify but also adds the value's location via loc

Attributes

Inherited from:
WithIdentifier
Source
AST.scala
def includes: Seq[Include[FunctionContents]]

A lazily constructed Seq of Include filtered from the contents

A lazily constructed Seq of Include filtered from the contents

Attributes

Inherited from:
WithIncludes
Source
AST.scala
final inline override def isAnonymous: Boolean

This one has an identifier so it is only anonymous if that identifier is empty

This one has an identifier so it is only anonymous if that identifier is empty

Attributes

Definition Classes
Inherited from:
WithIdentifier
Source
AST.scala
def isComment: Boolean

Determines if this RiddlValue is a comment or not

Determines if this RiddlValue is a comment or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala
final inline override def isContainer: Boolean

Force all subclasses to return true as they are containers

Force all subclasses to return true as they are containers

Attributes

Definition Classes
Inherited from:
Container
Source
AST.scala
override def isDefinition: Boolean

Yes anything deriving from here is a definition

Yes anything deriving from here is a definition

Attributes

Definition Classes
Inherited from:
Definition
Source
AST.scala
final inline override def isIdentified: Boolean

Whether or not this instance has an id: Identifier field or not

Whether or not this instance has an id: Identifier field or not

Attributes

Definition Classes
Inherited from:
WithIdentifier
Source
AST.scala
override def isParent: Boolean

Attributes

Definition Classes
Inherited from:
Parent
Source
AST.scala
def isProcessor: Boolean

Determines if this RiddlValue is a processor (handles messages) or not

Determines if this RiddlValue is a processor (handles messages) or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala
def isRootContainer: Boolean

Determine if this RiddlValue is the top most container, appearing at the root of the AST

Determine if this RiddlValue is the top most container, appearing at the root of the AST

Attributes

Inherited from:
RiddlValue
Source
AST.scala
final override def isVital: Boolean

Determines if this node is a vital node or not

Determines if this node is a vital node or not

Attributes

Definition Classes
Inherited from:
VitalDefinition
Source
AST.scala
final def nonEmpty: Boolean

implements the nonEmpty function based on the isEmpty function

implements the nonEmpty function based on the isEmpty function

Attributes

Inherited from:
RiddlValue
Source
AST.scala
def options: Seq[OptionValue]

A lazily constructed Seq of OptionValue filtered from the contents

A lazily constructed Seq of OptionValue filtered from the contents

Attributes

Inherited from:
WithOptions
Source
AST.scala
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def statements: Seq[Statement]

A lazily constructed Seq of Statement filtered from the contents

A lazily constructed Seq of Statement filtered from the contents

Attributes

Inherited from:
WithStatements
Source
AST.scala
def terms: Seq[Term]

A lazily constructed mutable Seq of AuthorRef

A lazily constructed mutable Seq of AuthorRef

Attributes

Inherited from:
WithMetaData
Source
AST.scala
def types: Seq[Type]

A lazily constructed Seq of Type filtered from the contents

A lazily constructed Seq of Type filtered from the contents

Attributes

Inherited from:
WithTypes
Source
AST.scala

Inherited fields

lazy val ulid: ULID

Attributes

Inherited from:
WithMetaData
Source
AST.scala
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.