StatsPass

com.reactific.riddl.stats.StatsPass
See theStatsPass companion object
case class StatsPass(input: PassInput, outputs: PassesOutput) extends CollectingPass[DefinitionStats]

Unit Tests For StatsPass

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Pass
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def name: String

THe name of the pass for inclusion in messages it produces.

THe name of the pass for inclusion in messages it produces. This must be implemented by the subclass

Attributes

Returns

A string value giving the name of this pass

A signal that the processing is complete and no more calls to process will be made.

A signal that the processing is complete and no more calls to process will be made. This also gives the Pass subclass a chance to do post-processing as some computations can only be done after collecting data from the entire AST

Value parameters

root

The in.root field just as a convenience

Attributes

Returns

Unit

override def result: StatsOutput

Generate the output of this Pass.

Generate the output of this Pass. This will only be called after all the calls to process have completed.

Attributes

Returns

an instance of the output type

Definition Classes

Inherited methods

def close(): Unit

Close any resources used so this can be used with AutoCloseable or Using.Manager

Close any resources used so this can be used with AutoCloseable or Using.Manager

Attributes

Inherited from:
Pass

The main implementation of the Pass.

The main implementation of the Pass. The AST is walked in a depth first manner calling this function for each definition it encounters.

Value parameters

definition

The definition to be processed

parents

The stack of definitions that are the parents of definition. This stack goes from immediate parent towards the root. The root is deepest in the stack.

Attributes

Definition Classes
Inherited from:
CollectingPass

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product
override protected def traverse(definition: Definition, parents: Stack[Definition]): Unit

Attributes

Definition Classes
Inherited from:
CollectingPass

Inherited fields

Attributes

Inherited from:
CollectingPass
val in: PassInput

Attributes

Inherited from:
Pass

Attributes

Inherited from:
Pass