Record Class Diagnostic

java.lang.Object
java.lang.Record
ca.mcscert.jpipe.compiler.model.Diagnostic
Record Components:
level - severity of the diagnostic.
code - stable kebab-case identifier, or null when absent.
source - path to the file that triggered it.
line - 1-based source line, or 0 if unknown.
column - 0-based column offset, or 0 if unknown.
message - human-readable description, without the code.
public record Diagnostic(Diagnostic.Level level, String code, String source, int line, int column, String message) extends Record
A single diagnostic message produced during compilation.

line and column carry the source location when known; both are 0 when no location is available (ANTLR lines are 1-based, so 0 is a safe sentinel).

code is a stable, bare kebab-case identifier such as "unknown-model" (see DiagnosticCodes) or a validation rule name coming from Violation.rule(). It is null when the diagnostic has no code. The code is data, not text: renderers decide how to display it (the human-readable report prefixes it as "[code] ", the JSON report emits it as a separate field).

  • Field Details

    • UNKNOWN_LOCATION

      public static final int UNKNOWN_LOCATION
      Sentinel value for line and column when no location is known.
      See Also:

  • Constructor Details

    • Diagnostic

      public Diagnostic(Diagnostic.Level level, String code, String source, int line, int column, String message)
      Creates an instance of a Diagnostic record class.
      Parameters:
      level - the value for the level record component
      code - the value for the code record component
      source - the value for the source record component
      line - the value for the line record component
      column - the value for the column record component
      message - the value for the message record component

  • Method Details

    • hasLocation

      public boolean hasLocation()
      True if this diagnostic carries a known source location.

    • hasCode

      public boolean hasCode()
      True if this diagnostic carries a code.

    • error

      public static Diagnostic error(String source, String message)

    • fatal

      public static Diagnostic fatal(String source, String message)

    • error

      public static Diagnostic error(String code, String source, String message)
      A non-fatal ERROR carrying a code but no source location.
      Parameters:
      code - stable kebab-case identifier, or null.
      source - path to the file that triggered it.
      message - human-readable description, without the code.
      Returns:
      the diagnostic.

    • error

      public static Diagnostic error(String source, int line, int column, String message)

    • fatal

      public static Diagnostic fatal(String source, int line, int column, String message)

    • error

      public static Diagnostic error(String code, String source, int line, int column, String message)
      A non-fatal ERROR carrying both a code and a source location.
      Parameters:
      code - stable kebab-case identifier, or null.
      source - path to the file that triggered it.
      line - 1-based source line.
      column - 0-based column offset.
      message - human-readable description, without the code.
      Returns:
      the diagnostic.

    • isError

      public boolean isError()
      True for ERROR and FATAL.

    • isFatal

      public boolean isFatal()
      True only for FATAL.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • level

      public Diagnostic.Level level()
      Returns the value of the level record component.
      Returns:
      the value of the level record component

    • code

      public String code()
      Returns the value of the code record component.
      Returns:
      the value of the code record component

    • source

      public String source()
      Returns the value of the source record component.
      Returns:
      the value of the source record component

    • line

      public int line()
      Returns the value of the line record component.
      Returns:
      the value of the line record component

    • column

      public int column()
      Returns the value of the column record component.
      Returns:
      the value of the column record component

    • message

      public String message()
      Returns the value of the message record component.
      Returns:
      the value of the message record component