gudusoft.gsqlparser.ir.semantic

Class Diagnostic

Object

gudusoft.gsqlparser.ir.semantic.Diagnostic

public final class Diagnostic
extends Object

Structured rejection from the SemanticIR builder. Carries a stable DiagnosticCode, centrally-derived DiagnosticCategory, a Severity, the rendered user-visible message, an optional primary SourceSpan, immutable secondary locations, and optional exact vendor-error enrichment.

API status: read-only diagnostic getters are part of Join Analysis Consumption Profile v1. Consumers should treat code, category, severity, locations, and exact vendor enrichment as structured data. Construction and copy helpers are producer-oriented APIs.

Diagnostics are constructed via the error(gudusoft.gsqlparser.ir.semantic.DiagnosticCode, java.lang.String) factory methods and wrapped in SemanticIRBuilder.SemanticIRBuildException when the builder cannot continue. External callers should pattern-match on getCode() rather than parsing getMessage() substrings — message text remains user-visible English and may change without notice; the enum values are the public contract.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Diagnostic.Builder Mutable construction helper; the built Diagnostic is immutable.

Method Summary

Modifier and Type	Method and Description
static Diagnostic.Builder	builder(DiagnosticCode code, Severity severity, String message) Begin constructing a diagnostic.
boolean	equals(Object o)
static Diagnostic	error(DiagnosticCode code, String message) Construct an ERROR-severity diagnostic with no span anchor.
static Diagnostic	error(DiagnosticCode code, String message, TParseTreeNode anchor) Construct an ERROR-severity diagnostic whose span is derived from anchor via SourceSpan.of(TParseTreeNode).
static Diagnostic	errorWithSpan(DiagnosticCode code, String message, SourceSpan span) Construct an ERROR-severity diagnostic with an explicit (already-computed) source span.
DiagnosticCategory	getCategory()
DiagnosticCode	getCode()
String	getMessage()
List<RelatedLocation>	getRelatedLocations()
Severity	getSeverity()
SourceSpan	getSpan()
VendorError	getVendorError()
int	hashCode()
String	toString()
static Diagnostic	warn(DiagnosticCode code, String message) Slice 77 — construct a WARN-severity diagnostic with no span anchor.
static Diagnostic	warn(DiagnosticCode code, String message, TParseTreeNode anchor) Slice 77 — construct a WARN-severity diagnostic whose span is derived from anchor.
static Diagnostic	warnWithSpan(DiagnosticCode code, String message, SourceSpan span) Construct a WARN-severity diagnostic with an explicit (already-computed) source span — the WARN counterpart of errorWithSpan(gudusoft.gsqlparser.ir.semantic.DiagnosticCode, java.lang.String, gudusoft.gsqlparser.ir.semantic.SourceSpan).
Diagnostic	withRelatedLocation(RelatedLocation location) Return an immutable copy with one additional secondary location.
Diagnostic	withSpan(SourceSpan newSpan) Return an immutable copy with a new primary span.
Diagnostic	withVendorError(VendorError error) Return an immutable copy enriched with an exact vendor error.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

error

public static Diagnostic error(DiagnosticCode code,
                               String message)

Construct an ERROR-severity diagnostic with no span anchor.

error

public static Diagnostic error(DiagnosticCode code,
                               String message,
                               TParseTreeNode anchor)

Construct an ERROR-severity diagnostic whose span is derived from anchor via SourceSpan.of(TParseTreeNode). Null-safe: when anchor (or its boundary tokens) is null, the resulting span is null.

errorWithSpan

public static Diagnostic errorWithSpan(DiagnosticCode code,
                                       String message,
                                       SourceSpan span)

Construct an ERROR-severity diagnostic with an explicit (already-computed) source span. Most callers should prefer error(DiagnosticCode, String, TParseTreeNode) which derives the span from an AST node.

warn

public static Diagnostic warn(DiagnosticCode code,
                              String message)

Slice 77 — construct a WARN-severity diagnostic with no span anchor. Warnings are advisory: the analyzer continues, the IR is built, and AnalysisResult.isSuccessful() still returns true.

warn

public static Diagnostic warn(DiagnosticCode code,
                              String message,
                              TParseTreeNode anchor)

Slice 77 — construct a WARN-severity diagnostic whose span is derived from anchor.

warnWithSpan

public static Diagnostic warnWithSpan(DiagnosticCode code,
                                      String message,
                                      SourceSpan span)

Construct a WARN-severity diagnostic with an explicit (already-computed) source span — the WARN counterpart of errorWithSpan(gudusoft.gsqlparser.ir.semantic.DiagnosticCode, java.lang.String, gudusoft.gsqlparser.ir.semantic.SourceSpan). Used by the builder's degrade paths, which derive the span from a fallback anchor rather than a single node.

builder

public static Diagnostic.Builder builder(DiagnosticCode code,
                                         Severity severity,
                                         String message)

Begin constructing a diagnostic. Category is intentionally absent from this API: it is derived centrally from DiagnosticCode.

getCode

public DiagnosticCode getCode()

getCategory

public DiagnosticCategory getCategory()

getSeverity

public Severity getSeverity()

getMessage

public String getMessage()

getSpan

public SourceSpan getSpan()

Returns:

the source span, or null when no AST anchor was available.

getRelatedLocations

public List<RelatedLocation> getRelatedLocations()

Returns:

immutable secondary source locations, never null.

getVendorError

public VendorError getVendorError()

Returns:

exact vendor enrichment, or null when not available.

withSpan

public Diagnostic withSpan(SourceSpan newSpan)

Return an immutable copy with a new primary span.

withRelatedLocation

public Diagnostic withRelatedLocation(RelatedLocation location)

Return an immutable copy with one additional secondary location.

withVendorError

public Diagnostic withVendorError(VendorError error)

Return an immutable copy enriched with an exact vendor error. Unsupported/degraded/advisory categories reject this operation.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object