DiagnosticPass

Base class for implementing pipeline diagnostics.

Implementations of this class should be aware of the following constraints:

Diagnostic classes must be stateless.
Diagnostic classes must override either DiagnosticPass.Warning or DiagnosticPass.Error.
Diagnostic classes must be a singleton (invokable by kotlin.reflect.KClass.objectInstance) or a class with a no-argument constructor (invokable by kotlin.reflect.full.createInstance).
Diagnostic classes must not mutate the Pipeline or its stages.

Constructors

protected constructor()

data class Diagnostic(val message: String, val _severity: DiagnosticPass.Diagnostic.Severity?, val _context: Map<String, Any?>?)

Data class representing an emitted diagnostic.

Base class for implementing one specific diagnostic check.

A diagnostic pass which has error severity.

A diagnostic pass which has warning severity.

open operator override fun equals(other: Any?): Boolean

Performs an equality check between this object and other.

Verifies whether the pipeline passes this diagnostic as if by calling invoke, and invokes onWarn or onErr depending on whether this diagnostic is a DiagnosticPass.Warning or DiagnosticPass.Error respectively.

open override fun hashCode(): Int

abstract operator override fun invoke(pipeline: Pipeline): List<Throwable>

Implementation of the diagnostic.

override fun test(pipeline: Pipeline): Boolean

fun verify(pipeline: Pipeline)

Verifies whether the pipeline passes this diagnostic as if by calling invoke, and throwing a VerificationException if it does not.