Record Class Obligation

java.lang.Object
java.lang.Record
org.ek9lang.compiler.phase5.Obligation
record Obligation(ObligationKind kind, DischargeReason discharge) extends Record
A single contract/partiality obligation found in a construct body, tagged with the analysis (if any) that discharges it (docs/tooling/EK9_SYMBOLIC_SCANNER_IMPLEMENTATION_SPEC.md ยง2.1). Kept as a record (rather than a bare count) so a later slice can roll up by kind and the Layer-2 solver can key its counterexamples to the undischarged ones.

  • Constructor Details

    • Obligation

      Obligation(ObligationKind kind, DischargeReason discharge)
      Creates an instance of a Obligation record class.
      Parameters:
      kind - the value for the kind record component
      discharge - the value for the discharge record component

  • Method Details

    • isDischarged

      boolean isDischarged()

    • 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.

    • kind

      public ObligationKind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • discharge

      public DischargeReason discharge()
      Returns the value of the discharge record component.
      Returns:
      the value of the discharge record component