RIDDL API Documentation
0.0.0-1-ad910350
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/Processor

Processor

com.ossuminc.riddl.language.AST.Processor
sealed trait Processor[CT <: RiddlValue] extends VitalDefinition[CT], WithConstants[CT], WithInvariants[CT], WithFunctions[CT], WithHandlers[CT], WithStreamlets[CT]

Definition of a Processor. This is a base class for all Processor definitions (things that have inlets, outlets, handlers, functions, and take messages directly with a reference). Processors are the active portion of a model since they handle messages and do the associated processing.

Type parameters

CT

The type of content that the Processor may contain

Attributes

Source
AST.scala
Graph
Supertypes
trait WithStreamlets[CT]
trait WithHandlers[CT]
trait WithFunctions[CT]
trait WithInvariants[CT]
trait WithConstants[CT]
trait VitalDefinition[CT]
trait WithComments[CT]
trait WithIncludes[CT]
trait WithTypes[CT]
trait Branch[CT]
trait Container[CT]
trait Definition
trait WithMetaData
trait RiddlValue
class Object
trait Matchable
class Any
Show all
Known subtypes
class Adaptor
class Context
class Entity
class Projector
class Repository
class Streamlet
Show all

Members list

Type members

Inherited and Abstract types

opaque type ContentType

Attributes

Inherited from:
Branch
Source
AST.scala

Value members

Concrete methods

final override 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

Definition Classes
Source
AST.scala

Inherited methods

def authorRefs: Seq[AuthorRef]

Return the AuthorRef instances from the metadata

Return the AuthorRef instances from the metadata

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 constants: Seq[Constant]

A lazily constructed Seq of Constant filtered from the contents

A lazily constructed Seq of Constant filtered from the contents

Attributes

Inherited from:
WithConstants
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 errorLoc: At

Attributes

Inherited from:
WithIdentifier
Source
AST.scala
def fileAttachments: Seq[FileAttachment]

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:
WithMetaData
Source
AST.scala
def handlers: Seq[Handler]

A lazily constructed Seq of Handler filtered from the contents

A lazily constructed Seq of Handler filtered from the contents

Attributes

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

Determine if the metadata has any author refs

Determine if the metadata has any author refs

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

Determine if this RiddlValue has definitions it contains

Determine if this RiddlValue has definitions it contains

Attributes

Definition Classes
Inherited from:
Branch
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

Determine if the metadata has any option values

Determine if the metadata has any option values

Attributes

Inherited from:
WithMetaData
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
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[CT]]

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
def invariants: Seq[Invariant]

A lazily constructed Seq of Invariant filtered from the contents

A lazily constructed Seq of Invariant filtered from the contents

Attributes

Inherited from:
WithInvariants
Source
AST.scala
final 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 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 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:
Branch
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
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
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]

Return the OptionValues in the meta data

Return the OptionValues in the meta data

Attributes

Inherited from:
WithMetaData
Source
AST.scala
def streamlets: Seq[Streamlet]

A lazily constructed Seq of Streamlet filtered from the contents

A lazily constructed Seq of Streamlet filtered from the contents

Attributes

Inherited from:
WithStreamlets
Source
AST.scala
def stringAttachments: Seq[StringAttachment]

Attributes

Inherited from:
WithMetaData
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 and Abstract methods

def contents: Contents[CT]

The definitional contents of this Container value.

The definitional contents of this Container value. The contents are constrained by the type parameter CV so subclasses must honor that constraint.

Attributes

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

Inherited from:
RiddlValue
Source
AST.scala
def id: Identifier

the name/identifier of this value.

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

Attributes

Inherited from:
WithIdentifier
Source
AST.scala
def loc: At

The point location in the parse at which this RiddlValue occurs

The point location in the parse at which this RiddlValue occurs

Attributes

Inherited from:
RiddlValue
Source
AST.scala
def metadata: Contents[MetaData]

Attributes

Inherited from:
WithMetaData
Source
AST.scala

Inherited fields

lazy val ulid: ULID

Get the ULID associated with the definition.

Get the ULID associated with the definition. There can only be one and they are assigned when this method is called, spreading their definition across the access patterns, on purpose.

Attributes

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