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/Root

Root

com.ossuminc.riddl.language.AST.Root
See theRoot companion object
case class Root(contents: ArrayBuffer[RootContents]) extends BranchDefinition[RootContents], WithModules[RootContents], WithDomains[RootContents], WithAuthors[RootContents], WithComments[RootContents], WithIncludes[RootContents]

The root of the containment hierarchy, corresponding roughly to a level about a file.

Value parameters

contents

The sequence top level definitions contained by this root container

Attributes

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

Members list

Value members

Concrete methods

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

Source
AST.scala
override def id: Identifier

the name/identifier of this value.

the name/identifier of this value. All definitions have one

Attributes

Definition Classes
Source
AST.scala
override 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

Definition Classes
Source
AST.scala
override 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

Definition Classes
Source
AST.scala
override 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

Definition Classes
Source
AST.scala
def loc: At

The location in the parse at which this RiddlValue occurs

The location in the parse at which this RiddlValue occurs

Attributes

Source
AST.scala

Inherited methods

def authors: Seq[Author]

A lazily constructed Seq of Author filtered from the contents

A lazily constructed Seq of Author filtered from the contents

Attributes

Inherited from:
WithAuthors
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 domains: Seq[Domain]

A lazily constructed Seq of Domain filtered from the contents

A lazily constructed Seq of Domain filtered from the contents

Attributes

Inherited from:
WithDomains
Source
AST.scala
def hasAuthorRefs: Boolean

Determines if this RiddlValue references any Authors or not

Determines if this RiddlValue references any Authors or not

Attributes

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

Determines if this RiddlValuedefines any Authors or not

Determines if this RiddlValuedefines any Authors or not

Attributes

Definition Classes
Inherited from:
WithAuthors
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 hasOptions: Boolean

Determines if this RiddlValue has any options set or not

Determines if this RiddlValue has any options set or not

Attributes

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

Determines if this RiddlValue contains any type definitions

Determines if this RiddlValue contains any type definitions

Attributes

Inherited from:
RiddlValue
Source
AST.scala
def includes: Seq[Include[RootContents]]

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
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
Inherited from:
Container
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 isVital: Boolean

Determines if this node is a vital node or not

Determines if this node is a vital node or not

Attributes

Inherited from:
RiddlValue
Source
AST.scala
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

Inherited from:
RiddlValue
Source
AST.scala
def modules: Seq[Module]

A lazily constructed Contents of Module

A lazily constructed Contents of Module

Attributes

Inherited from:
WithModules
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 productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with
Copyright 2019 Ossum, Inc.. All Rights Reserved.
Copyright 2019 Ossum, Inc.. All Rights Reserved.