RIDDL
3.3.1
API
Generated with
RIDDL/com.reactific.riddl.passes/com.reactific.riddl.passes.validate/ValidationPass

ValidationPass

com.reactific.riddl.passes.validate.ValidationPass
See theValidationPass companion object
case class ValidationPass(input: PassInput) extends Pass, StreamingValidation

The ValidationPass

Value parameters

input

Input from previous passes

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

override 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

Attributes

Returns

A string value giving the name of this pass

Definition Classes
def process(definition: Definition, parents: Stack[Definition]): Unit
override def result: ValidationOutput

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 areSameType(typ1: Option[Type], typ2: Option[Type]): Boolean

Attributes

Inherited from:
TypeValidation
def areSameType(tr1: Reference[Type], tr2: Reference[Type], parents: Seq[Definition]): Boolean

Attributes

Inherited from:
TypeValidation
def article(thing: String): String

Attributes

Inherited from:
BasicValidation
def check(predicate: Boolean, message: => String, kind: KindOfMessage, loc: At): BasicValidation.this.type

Attributes

Inherited from:
BasicValidation
def checkContainer(parents: Seq[Definition], container: Definition): DefinitionValidation.this.type

Attributes

Inherited from:
DefinitionValidation
def checkDefinition(parents: Seq[Definition], definition: Definition): DefinitionValidation.this.type

Attributes

Inherited from:
DefinitionValidation
def checkDescription[TD <: Definition](definition: TD): DefinitionValidation.this.type

Attributes

Inherited from:
DefinitionValidation
def checkDescription[TD <: DescribedValue](id: String, value: TD): DefinitionValidation.this.type

Attributes

Inherited from:
DefinitionValidation
def checkIdentifierLength[T <: Definition](d: T, min: Int): BasicValidation.this.type

Attributes

Inherited from:
BasicValidation
def checkMaybeRef[T <: Definition : ClassTag](reference: Option[Reference[T]], definition: Definition, parents: Seq[Definition]): Option[T]

Attributes

Inherited from:
BasicValidation
def checkMessageRef(ref: MessageRef, topDef: Definition, parents: Seq[Definition], kinds: Seq[AggregateUseCase]): BasicValidation.this.type

Attributes

Inherited from:
BasicValidation
def checkNonEmpty(list: Seq[_], name: String, thing: Definition, kind: KindOfMessage, required: Boolean): BasicValidation.this.type

Attributes

Inherited from:
BasicValidation
def checkNonEmptyValue(value: RiddlValue, name: String, thing: Definition, kind: KindOfMessage, required: Boolean): BasicValidation.this.type

Attributes

Inherited from:
BasicValidation
def checkOption[A <: RiddlValue](opt: Option[A], name: String, thing: Definition)(checker: A => Unit): DefinitionValidation.this.type

Attributes

Inherited from:
DefinitionValidation
def checkOptions[T <: OptionValue](options: Seq[T], loc: At): DefinitionValidation.this.type

Attributes

Inherited from:
DefinitionValidation
def checkOverloads(): BasicValidation.this.type

Attributes

Inherited from:
BasicValidation
def checkPathRef[T <: Definition : ClassTag](pid: PathIdentifier, container: Definition, parents: Seq[Definition]): Option[T]

Attributes

Inherited from:
BasicValidation
def checkRef[T <: Definition : ClassTag](reference: Reference[T], definition: Definition, parents: Seq[Definition]): Option[T]

Attributes

Inherited from:
BasicValidation
def checkRefAndExamine[T <: Definition : ClassTag](reference: Reference[T], defn: Definition, parents: Seq[Definition])(examiner: T => Unit): BasicValidation.this.type

Attributes

Inherited from:
BasicValidation
def checkSequence[A](elements: Seq[A])(check: A => Unit): BasicValidation.this.type

Attributes

Inherited from:
BasicValidation
def checkStreaming(root: RootContainer): Unit

Attributes

Inherited from:
StreamingValidation
def checkStreamletShape(proc: Streamlet): DefinitionValidation.this.type

Attributes

Inherited from:
DefinitionValidation
def checkTypeExpression(typ: TypeExpression, defn: Definition, parents: Seq[Definition]): TypeValidation.this.type

Attributes

Inherited from:
TypeValidation
def checkWhen(predicate: Boolean)(checker: () => Unit): BasicValidation.this.type

Attributes

Inherited from:
BasicValidation
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
final def getPathIdType(pid: PathIdentifier, parents: Seq[Definition]): Option[TypeExpression]

Attributes

Inherited from:
BasicValidation
def isAssignmentCompatible(typeEx1: Option[TypeExpression], typeEx2: Option[TypeExpression]): Boolean

Attributes

Inherited from:
TypeValidation
def lookup[T <: Definition : ClassTag](id: Seq[String]): List[T]

Attributes

Inherited from:
BasicValidation
def parentOf(definition: Definition): Container[Definition]

Attributes

Inherited from:
BasicValidation
def pathIdToDefinition(pid: PathIdentifier, parents: Seq[Definition]): Option[Definition]

Attributes

Inherited from:
BasicValidation
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def resolvePath[T <: Definition](pid: PathIdentifier, parents: Seq[Definition]): Option[T]

Attributes

Inherited from:
BasicValidation
def resolvePidRelativeTo[T <: Definition](pid: PathIdentifier, relativeTo: Definition): Option[T]

Attributes

Inherited from:
BasicValidation

Concrete fields

lazy val messages: Accumulator

Inherited fields

val connectors: Seq[Connector]

Attributes

Inherited from:
StreamingValidation
val inlets: Seq[Inlet]

Attributes

Inherited from:
StreamingValidation
val outlets: Seq[Outlet]

Attributes

Inherited from:
StreamingValidation
val streamlets: Seq[Streamlet]

Attributes

Inherited from:
StreamingValidation
Generated with