Package com.nsdev.lettergenerator.diagnostics

Record Class Diagnostic

java.lang.Object
java.lang.Record
com.nsdev.lettergenerator.diagnostics.Diagnostic
Record Components:
code - machine-readable classification
severity - diagnostic severity
phase - processing stage
path - input field or template selector
message - readable explanation
All Implemented Interfaces:
Serializable
public record Diagnostic(String code, DiagnosticSeverity severity, DiagnosticPhase phase, String path, String message) extends Record implements Serializable
Stable diagnostic code with a human-readable message and input location.

Instances are serializable for exception transport. Serialized values correspond to the record components documented below.

  • Constructor Details

    • Diagnostic

      public Diagnostic(String code, DiagnosticSeverity severity, DiagnosticPhase phase, String path, String message)
      Creates an instance of a Diagnostic record class.
      Parameters:
      code - the value for the code record component
      severity - the value for the severity record component
      phase - the value for the phase record component
      path - the value for the path record component
      message - the value for the message record component

  • Method Details

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • code

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

    • severity

      public DiagnosticSeverity severity()
      Returns the value of the severity record component.
      Returns:
      the value of the severity record component

    • phase

      public DiagnosticPhase phase()
      Returns the value of the phase record component.
      Returns:
      the value of the phase record component

    • path

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

    • message

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