Class DefaultValidationCollector<Specifics>

Type Parameters

Specifics extends TypirSpecifics

Hierarchy (View Summary)

DefaultValidationCollector
- CompositeValidationRule
- DefaultLangiumValidationCollector

Implements

Index

Constructors

constructor

new DefaultValidationCollector<Specifics extends TypirSpecifics>(
services: TypirServices<Specifics>,
): DefaultValidationCollector<Specifics>
Type Parameters
- Specifics extends TypirSpecifics
Parameters
- services: TypirServices<Specifics>
Returns DefaultValidationCollector<Specifics>
- Defined in services/validation.ts:245

Properties

`Protected` `Readonly`listeners

listeners: ValidationCollectorListener<Specifics>[] = []

`Protected` `Readonly`ruleRegistryFunctional

ruleRegistryFunctional: RuleRegistry<
ValidationRuleFunctional<Specifics, Specifics["LanguageType"]>,
Specifics,
>

`Protected` `Readonly`ruleRegistryLifecycle

ruleRegistryLifecycle: RuleRegistry<
    ValidationRuleLifecycle<
        Specifics,
        Specifics["LanguageType"],
        Specifics["LanguageType"],
    >,
    Specifics,
>

`Protected` `Readonly`services

services: TypirServices<Specifics>

Methods

addListener

addListener(listener: ValidationCollectorListener<Specifics>): void
Parameters
- listener: ValidationCollectorListener<Specifics>
Returns void
Implementation of ValidationCollector.addListener
- Defined in services/validation.ts:338

addValidationRule

addValidationRule<InputType extends unknown = Specifics["LanguageType"]>(
rule: ValidationRule<Specifics, InputType>,
givenOptions?: Partial<ValidationRuleOptions>,
): void
Registers a validation rule.
Type Parameters
- InputType extends unknown = Specifics["LanguageType"]
Parameters
- rule: ValidationRule<Specifics, InputType>
  a new validation rule
- OptionalgivenOptions: Partial<ValidationRuleOptions>
  some more options to control the handling of the added validation rule
Returns void
Implementation of ValidationCollector.addValidationRule
- Defined in services/validation.ts:322

`Protected`createAcceptor

createAcceptor(
problems: ValidationProblem<Specifics, Specifics["LanguageType"]>[],
): ValidationProblemAcceptor<Specifics>
Parameters
- problems: ValidationProblem<Specifics, Specifics["LanguageType"]>[]
Returns ValidationProblemAcceptor<Specifics>
- Defined in services/validation.ts:255

onAddedRule

onAddedRule(rule: ValidationRule<Specifics>, diffOptions: RuleOptions): void
Parameters
- rule: ValidationRule<Specifics>
- diffOptions: RuleOptions
Returns void
Implementation of RuleCollectorListener.onAddedRule
- Defined in services/validation.ts:345

onRemovedRule

onRemovedRule(rule: ValidationRule<Specifics>, diffOptions: RuleOptions): void
Parameters
- rule: ValidationRule<Specifics>
- diffOptions: RuleOptions
Returns void
Implementation of RuleCollectorListener.onRemovedRule
- Defined in services/validation.ts:349

removeListener

removeListener(listener: ValidationCollectorListener<Specifics>): void
Parameters
- listener: ValidationCollectorListener<Specifics>
Returns void
Implementation of ValidationCollector.removeListener
- Defined in services/validation.ts:341

removeValidationRule

removeValidationRule<InputType extends unknown = Specifics["LanguageType"]>(
rule: ValidationRule<Specifics, InputType>,
givenOptions?: Partial<ValidationRuleOptions>,
): void
Removes a validation rule.
Type Parameters
- InputType extends unknown = Specifics["LanguageType"]
Parameters
- rule: ValidationRule<Specifics, InputType>
  the validation rule to remove
- OptionalgivenOptions: Partial<ValidationRuleOptions>
  the same options as given for the registration of the validation rule must be given for the removal!
Returns void
Implementation of ValidationCollector.removeValidationRule
- Defined in services/validation.ts:330

validate

validate(
languageNode: Specifics["LanguageType"],
): ValidationProblem<Specifics, Specifics["LanguageType"]>[]
Parameters
- languageNode: Specifics["LanguageType"]
Returns ValidationProblem<Specifics, Specifics["LanguageType"]>[]
Implementation of ValidationCollector.validate
- Defined in services/validation.ts:273

validateAfter

validateAfter(
languageRoot: Specifics["LanguageType"],
): ValidationProblem<Specifics, Specifics["LanguageType"]>[]
Parameters
- languageRoot: Specifics["LanguageType"]
Returns ValidationProblem<Specifics, Specifics["LanguageType"]>[]
Implementation of ValidationCollector.validateAfter
- Defined in services/validation.ts:313

validateBefore

validateBefore(
languageRoot: Specifics["LanguageType"],
): ValidationProblem<Specifics, Specifics["LanguageType"]>[]
Parameters
- languageRoot: Specifics["LanguageType"]
Returns ValidationProblem<Specifics, Specifics["LanguageType"]>[]
Implementation of ValidationCollector.validateBefore
- Defined in services/validation.ts:264

Class DefaultValidationCollector<Specifics>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns DefaultValidationCollector<Specifics>

Properties

Protected Readonlylisteners

Protected ReadonlyruleRegistryFunctional

Protected ReadonlyruleRegistryLifecycle

Protected Readonlyservices

Methods

addListener

Parameters

Returns void

addValidationRule

Type Parameters

Parameters

Returns void

ProtectedcreateAcceptor

Parameters

Returns ValidationProblemAcceptor<Specifics>

onAddedRule

Parameters

Returns void

onRemovedRule

Parameters

Returns void

removeListener

Parameters

Returns void

removeValidationRule

Type Parameters

Parameters

Returns void

validate

Parameters

Returns ValidationProblem<Specifics, Specifics["LanguageType"]>[]

validateAfter

Parameters

Returns ValidationProblem<Specifics, Specifics["LanguageType"]>[]

validateBefore

Parameters

Returns ValidationProblem<Specifics, Specifics["LanguageType"]>[]

Settings

On This Page

`Protected` `Readonly`listeners

`Protected` `Readonly`ruleRegistryFunctional

`Protected` `Readonly`ruleRegistryLifecycle

`Protected` `Readonly`services

`Protected`createAcceptor