SpecRootDefinition class

What a document of one root is checked against: the model, the root's metadata tree and type, and its DocSpecs schema. A generated facade supplies them (tom_som_dart_v0: somSpecModel, d00SolutionBlueprintMetaTree, somDocSpecsSchema('solution-blueprint')), so the checks themselves need no facade.

Constructors

SpecRootDefinition({required SpecModel model, required SomMetaTree tree, required String rootType, required DocSpecsSchema schema})
Bundles what the checks of one document root need.
const

Properties

hashCode → int
The hash code for this object.
no setterinherited
model → SpecModel
The object model the document belongs to.
final
rootType → String
The model root type, e.g. D00SolutionBlueprint.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schema → DocSpecsSchema
The DocSpecs schema the root's markdown rendition is held to.
final
tree → SomMetaTree
The metadata tree a document of this root decodes against.
final

Methods

decode(String yamlText) → SpecDocument
Decodes a document of this root from its YAML text (tier 1).
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
render(SpecDocument doc) → String
Renders the DocSpecs markdown rendition of a decoded document.
toString() → String
A string representation of this object.
inherited
validate(SpecDocument doc, {String? markdown}) → SbpValidation
Runs tiers 2 and 3 on doc; markdown is its rendition when the caller already rendered it.

Operators

operator ==(Object other) → bool
The equality operator.
inherited