stig-core/com.stigway.metamodels.create

Package-level declarations

Types

data class AddListItemFix(val entityId: String, val argument: String, val expression: FixExpression, val title: String = "Add ") : ModelQuickFix

AnalysisClassesTopLevelRule

class AnalysisClassesTopLevelRule : ViewpointClassesTopLevelRule

AnalysisClassInstanceRule

class AnalysisClassInstanceRule : ViewpointClassInstanceRule

AnalysisClassPascalCaseRule

class AnalysisClassPascalCaseRule : ViewpointClassPascalCaseRule

AnalysisDescriptionActiveVoiceRule

class AnalysisDescriptionActiveVoiceRule : DescriptionActiveVoiceRule

AnalysisObjectCamelCaseRule

class AnalysisObjectCamelCaseRule : ViewpointObjectCamelCaseRule

BoundaryLinksRule

abstract class BoundaryLinksRule<T : Any>(type: KClass<T>, val viewpoint: Viewpoint, attribute: String, boundary: String, violates: (T) -> Boolean) : ModelInventoryRule

An authored reference contradicts an explicitly excluded model boundary.

CheckCategories

data class CheckCategories(val context: Boolean = true, val requirements: Boolean = true, val design: Boolean = true, val analysis: Boolean = true, val tests: Boolean = true)

Configuration for which viewpoints to check for a module.

ChooseReferenceFix

data class ChooseReferenceFix(val entityId: String, val argument: String, val candidateEntityIds: List<String>, val valueKind: FixValueKind, val listArgument: Boolean = false, val title: String = "Choose ") : ModelQuickFix

ContextClassesTopLevelRule

class ContextClassesTopLevelRule : ViewpointClassesTopLevelRule

ContextClassInstanceRule

class ContextClassInstanceRule : ViewpointClassInstanceRule

ContextClassPascalCaseRule

class ContextClassPascalCaseRule : ViewpointClassPascalCaseRule

ContextDescriptionActiveVoiceRule

class ContextDescriptionActiveVoiceRule : DescriptionActiveVoiceRule

ContextObjectCamelCaseRule

class ContextObjectCamelCaseRule : ViewpointObjectCamelCaseRule

CreateChildEntityFix

data class CreateChildEntityFix(val ownerEntityId: String, val childKind: String, val template: String, val title: String = "Create ") : ModelQuickFix

DefaultRules

object DefaultRules

Default rule sets, grouped by viewpoint.

DescriptionActiveVoiceRule

abstract class DescriptionActiveVoiceRule(val viewpoint: Viewpoint) : SemanticModelRule

Shared description contract; each registration preserves its viewpoint's enablement and identity.

DescriptionDefinedInAnalysisPackageRule

class DescriptionDefinedInAnalysisPackageRule : ModelRule

DescriptionDefinedInContextPackageRule

class DescriptionDefinedInContextPackageRule : ModelRule

DescriptionDefinedInDesignPackageRule

class DescriptionDefinedInDesignPackageRule : ModelRule

DescriptionDefinedInRequirementsPackageRule

class DescriptionDefinedInRequirementsPackageRule : ModelRule

DescriptionDefinedInTestsPackageRule

class DescriptionDefinedInTestsPackageRule : ModelRule

DesignClassesTopLevelRule

class DesignClassesTopLevelRule : ViewpointClassesTopLevelRule

DesignClassInstanceRule

class DesignClassInstanceRule : ViewpointClassInstanceRule

DesignClassPascalCaseRule

class DesignClassPascalCaseRule : ViewpointClassPascalCaseRule

DesignDescriptionActiveVoiceRule

class DesignDescriptionActiveVoiceRule : DescriptionActiveVoiceRule

DesignObjectCamelCaseRule

class DesignObjectCamelCaseRule : ViewpointObjectCamelCaseRule

ElementTopLevelNoParentRule

class ElementTopLevelNoParentRule : BoundaryLinksRule<Element>

FixExpression

data class FixExpression(val text: String, val referencedEntityId: String? = null)

Expression inserted by a quick fix. If referencedEntityId is set, an IDE should prefer the referenced entity's source-property name over text.

FixValueKind

enum FixValueKind : Enum<FixValueKind>

ForbiddenWordsInAnalysisRule

class ForbiddenWordsInAnalysisRule : ForbiddenWordsInViewpointRule

ForbiddenWordsInContextRule

class ForbiddenWordsInContextRule : ForbiddenWordsInViewpointRule

ForbiddenWordsInDesignRule

class ForbiddenWordsInDesignRule : ForbiddenWordsInViewpointRule

ForbiddenWordsInTestsRule

class ForbiddenWordsInTestsRule : ForbiddenWordsInViewpointRule

ForbiddenWordsInViewpointRule

abstract class ForbiddenWordsInViewpointRule(val viewpoint: Viewpoint, forbiddenWords: Set<String> = when (viewpoint) { Viewpoint.REQUIREMENTS, Viewpoint.TESTS -> DEFAULT_FORBIDDEN_WORDS else -> DEFAULT_PLACEHOLDER_WORDS }) : ModelInventoryRule

Shared string-value check; registrations retain independent viewpoint identities and settings.

IncompleteModelContextException

class IncompleteModelContextException(val elementIds: List<String>) : IllegalStateException

A loader failure is an execution problem, not an unassessed automated model rule.

InterfaceDirection

enum InterfaceDirection : Enum<InterfaceDirection>

The direction of an interface use relative to the element exposing or consuming it.

InterfaceEntityAsilDefinedRule

class InterfaceEntityAsilDefinedRule : ModelInventoryRule

Covers ASIL-bearing context entities beyond Elements (ports, signals, connectors, etc.).

KotlinDeclarationKind

enum KotlinDeclarationKind : Enum<KotlinDeclarationKind>

KotlinModelArgument

data class KotlinModelArgument(val name: String?, val reference: String?)

KotlinModelDeclaration

data class KotlinModelDeclaration(val kind: KotlinDeclarationKind, val name: String, val qualifiedName: String, val line: Int, val offset: Int, val topLevel: Boolean, val concrete: Boolean = false, val constructedType: String? = null, val declaredType: String? = null, val superTypes: List<String> = emptyList(), val interfacePoint: String? = null, val constructorCalls: Map<String, List<KotlinModelArgument>> = emptyMap(), val constructorParameters: Set<String> = emptySet(), val memberProperty: Boolean = false)

KotlinModelSource

data class KotlinModelSource(val path: String, val packageName: String, val declarations: List<KotlinModelDeclaration>, val imports: Map<String, String>, val typeAliases: Map<String, String>)

Physical declarations, including uninstantiated classes, shared by batch and live-source checks.

ModelCheckMode

enum ModelCheckMode : Enum<ModelCheckMode>

Selects executable findings and/or obligations requiring human or AI judgment.

ModelCheckSession

class ModelCheckSession(scope: ModelScope, val index: ModelIndex)

One prepared model and one result per rule, shared by all inspections of a module.

ModelDeclarationNames

object ModelDeclarationNames

Naming contracts concern Kotlin identifiers, not authored display names or descriptions.

ModelIndex

class ModelIndex

Inventory, declaration ownership, and interface membership shared by compiled checks and live source inspections.

ModelInventoryRule

interface ModelInventoryRule : ModelRule

A rule that runs once against the inventory, including when a specification is absent.

ModelModuleIndex

class ModelModuleIndex<M>(inventory: ModelIndex, declarationModule: (MetamodelEntity) -> M?, logicalOwners: Map<String, M> = emptyMap())

Classifies declarations and element ownership once, including for a multi-module full-model run.

ModelModuleScope

class ModelModuleScope<M>

A check owns its subject modules and reads the complete models of their dependencies. Both compiled and PSI adapters supply their ordinary module graph; reverse dependents are deliberately outside this scope. No Gradle or IDE types belong in the rule engine.

ModelProblem

data class ModelProblem(val rule: ModelRule, val severity: ProblemSeverity, val message: String, val entityName: String? = null, val sourceFile: String? = null, val sourceLine: Int? = null, val remediation: String? = null, val quickFixes: List<ModelQuickFix> = emptyList(), val kind: SarifKind = SarifKind.FAIL, val ownerElementId: String? = null, val relatedEntityIds: List<String> = emptyList(), val subjectId: String? = null, val sourceOffset: Int? = null, val remediationInventory: ModelRemediationInventory? = null, val remediationSummary: String? = null)

A rule result: a violation, pending review, unresolved assessment, or explicit disposition.

ModelQuickFix

sealed interface ModelQuickFix

Structured model-fix metadata emitted by validation rules.

ModelReferenceNames

object ModelReferenceNames

Editable defaults for authored references; these suggestions never assign a model's identity.

ModelRemediationInventory

data class ModelRemediationInventory(val id: String, val guidance: String)

Complete candidate guidance stored once in diagnostic reports, separately from each correction.

ModelRule

interface ModelRule

A model rule dispatched by viewpoint and container type, or over ModelIndex by ModelInventoryRule.

MoveDeclarationFix

data class MoveDeclarationFix(val entityId: String, val targetKind: MoveTargetKind, val title: String = "Move declaration") : ModelQuickFix

MoveTargetKind

enum MoveTargetKind : Enum<MoveTargetKind>

NameDefinedInAnalysisPackageRule

class NameDefinedInAnalysisPackageRule : ModelRule

NameDefinedInContextPackageRule

class NameDefinedInContextPackageRule : ModelRule

NameDefinedInDesignPackageRule

class NameDefinedInDesignPackageRule : ModelRule

NameDefinedInRequirementsPackageRule

class NameDefinedInRequirementsPackageRule : ModelRule

NameDefinedInTestsPackageRule

class NameDefinedInTestsPackageRule : ModelRule

NonAnalysisEntityInAnalysisPackageRule

class NonAnalysisEntityInAnalysisPackageRule : ModelRule

NonContextEntityInContextPackageRule

class NonContextEntityInContextPackageRule : ModelRule

NonDesignEntityInDesignPackageRule

class NonDesignEntityInDesignPackageRule : ModelRule

NonRequirementsEntityInRequirementsPackageRule

class NonRequirementsEntityInRequirementsPackageRule : ModelRule

NonTestsEntityInTestsPackageRule

class NonTestsEntityInTestsPackageRule : ModelRule

PromptSetArgumentFix

data class PromptSetArgumentFix(val entityId: String, val argument: String, val valueKind: FixValueKind, val listArgument: Boolean = false, val title: String = "Set ") : ModelQuickFix

RemoveArgumentFix

data class RemoveArgumentFix(val entityId: String, val argument: String, val title: String = "Remove ") : ModelQuickFix

RemoveListItemFix

data class RemoveListItemFix(val entityId: String, val argument: String, val expression: FixExpression, val title: String = "Remove ") : ModelQuickFix

ReplaceListItemFix

data class ReplaceListItemFix(val entityId: String, val argument: String, val oldExpression: FixExpression, val newExpression: FixExpression, val title: String = "Replace ") : ModelQuickFix

RequiredAttributeRule

abstract class RequiredAttributeRule<T : Any>(type: KClass<T>, val viewpoint: Viewpoint, attribute: String, valueKind: FixValueKind, listArgument: Boolean = false, missing: (T) -> Boolean) : ModelInventoryRule

Required values and references have one severity policy, independent of hierarchy boundaries.

RequirementBottomLevelNoAllocationRule

class RequirementBottomLevelNoAllocationRule : BoundaryLinksRule<Requirement>

RequirementContainerElementDefinedRule

class RequirementContainerElementDefinedRule : RequiredAttributeRule<Requirements>

RequirementsClassesTopLevelRule

class RequirementsClassesTopLevelRule : ViewpointClassesTopLevelRule

RequirementsClassInstanceRule

class RequirementsClassInstanceRule : ViewpointClassInstanceRule

RequirementsClassPascalCaseRule

class RequirementsClassPascalCaseRule : ViewpointClassPascalCaseRule

RequirementsDescriptionActiveVoiceRule

class RequirementsDescriptionActiveVoiceRule : DescriptionActiveVoiceRule

RequirementsObjectCamelCaseRule

class RequirementsObjectCamelCaseRule : ViewpointObjectCamelCaseRule

RequirementVerificationCriteriaDefinedRule

class RequirementVerificationCriteriaDefinedRule : RequiredAttributeRule<Requirement>

RewriteStringArgumentFix

data class RewriteStringArgumentFix(val entityId: String, val argument: String, val template: String, val title: String = "Rewrite ") : ModelQuickFix

RuleDocumentation

object RuleDocumentation

Official CREATE-rule documentation, using the existing rule ID unchanged as its anchor.

RuleEvaluation

enum RuleEvaluation : Enum<RuleEvaluation>

Decision method, independent of SarifKind and severity.

RuleText

object RuleText

Renders rule prose (paragraphs, bullet lists and inline code) as escaped HTML for native inspection help.

SafetyMeasureAsilDefinedRule

class SafetyMeasureAsilDefinedRule : RequiredAttributeRule<SafetyMeasure>

SarifKind

enum SarifKind : Enum<SarifKind>

SARIF 2.1.0 result.kind field.

SarifLevel

enum SarifLevel : Enum<SarifLevel>

SARIF 2.1.0 result.level field.

SemanticModelRule

abstract class SemanticModelRule : ModelInventoryRule

Selects evidence for engineering judgment; Kotlin emits no semantic pass or violation.

SetArgumentFix

data class SetArgumentFix(val entityId: String, val argument: String, val expression: FixExpression, val title: String = "Set ") : ModelQuickFix

SourceDeclarationRule

interface SourceDeclarationRule : ModelInventoryRule

Marker lets live inspections check declarations even when the file creates no metamodel entities.

TestCaseContainerElementDefinedRule

class TestCaseContainerElementDefinedRule : RequiredAttributeRule<Tests>

TestsClassesTopLevelRule

class TestsClassesTopLevelRule : ViewpointClassesTopLevelRule

TestsClassInstanceRule

class TestsClassInstanceRule : ViewpointClassInstanceRule

TestsClassPascalCaseRule

class TestsClassPascalCaseRule : ViewpointClassPascalCaseRule

TestsDescriptionActiveVoiceRule

class TestsDescriptionActiveVoiceRule : DescriptionActiveVoiceRule

TestsObjectCamelCaseRule

class TestsObjectCamelCaseRule : ViewpointObjectCamelCaseRule

ViewpointClassesTopLevelRule

abstract class ViewpointClassesTopLevelRule(val viewpoint: Viewpoint) : SourceDeclarationRule

ViewpointClassInstanceRule

abstract class ViewpointClassInstanceRule(val viewpoint: Viewpoint) : SourceDeclarationRule

ViewpointClassPascalCaseRule

abstract class ViewpointClassPascalCaseRule(val viewpoint: Viewpoint) : SourceDeclarationRule

ViewpointObjectCamelCaseRule

abstract class ViewpointObjectCamelCaseRule(val viewpoint: Viewpoint) : SourceDeclarationRule

Functions

runInventoryChecks

fun runInventoryChecks(rules: List<ModelRule>, index: ModelIndex, viewpoints: Set<Viewpoint> = Viewpoint.entries.toSet(), onRuleEvaluated: (ModelRule) -> Unit = {}, reportClassificationDifferences: Boolean = index.reportClassificationDifferences): List<ModelProblem>

Runs each rule over its actual subjects; no viewpoint container is fabricated for missing specifications.

runModelChecks

fun runModelChecks(rules: List<ModelRule>, container: MetamodelEntity): List<ModelProblem>

Runs a set of ModelRules against a viewpoint container and collects problems.

runModuleChecks

fun runModuleChecks(rules: List<ModelRule>, containers: Map<Viewpoint, MetamodelEntity>, categories: CheckCategories = CheckCategories()): List<ModelProblem>

Runs all rules that match the enabled categories against the given containers.