Module aya.base
Package org.aya.tyck.error

Record Class Goal

java.lang.Object
java.lang.Record
org.aya.tyck.error.Goal
All Implemented Interfaces:
org.aya.util.reporter.Problem
public record Goal(@NotNull TyckState state, @NotNull MetaTerm hole, @NotNull kala.collection.immutable.ImmutableSeq<LocalVar> scope) extends Record implements org.aya.util.reporter.Problem

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.aya.util.reporter.Problem

    org.aya.util.reporter.Problem.Severity, org.aya.util.reporter.Problem.Stage

  • Field Summary

    Fields inherited from interface org.aya.util.reporter.Problem

    ERROR, NOTE, TEXT

  • Constructor Summary

    Constructors
    Constructor
    Description
    Goal(@NotNull TyckState state, @NotNull MetaTerm hole, @NotNull kala.collection.immutable.ImmutableSeq<LocalVar> scope)
    Creates an instance of a Goal record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull org.aya.pretty.doc.Doc
    describe(@NotNull org.aya.util.distill.DistillerOptions options)
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    @NotNull MetaTerm
    hole()
    Returns the value of the hole record component.
    @NotNull org.aya.util.reporter.Problem.Severity
    level()
     
    @NotNull kala.collection.immutable.ImmutableSeq<LocalVar>
    scope()
    Returns the value of the scope record component.
    @NotNull org.aya.util.error.SourcePos
    sourcePos()
     
    @NotNull org.aya.util.reporter.Problem.Stage
    stage()
     
    @NotNull TyckState
    state()
    Returns the value of the state record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.aya.util.reporter.Problem

    brief, hint, inlineHints, isError, toPrettyError

  • Constructor Details

    • Goal

      public Goal(@NotNull @NotNull TyckState state, @NotNull @NotNull MetaTerm hole, @NotNull @NotNull kala.collection.immutable.ImmutableSeq<LocalVar> scope)
      Creates an instance of a Goal record class.
      Parameters:
      state - the value for the state record component
      hole - the value for the hole record component
      scope - the value for the scope record component

  • Method Details

    • describe

      @NotNull public @NotNull org.aya.pretty.doc.Doc describe(@NotNull @NotNull org.aya.util.distill.DistillerOptions options)
      Specified by:
      describe in interface org.aya.util.reporter.Problem

    • sourcePos

      @NotNull public @NotNull org.aya.util.error.SourcePos sourcePos()
      Specified by:
      sourcePos in interface org.aya.util.reporter.Problem

    • level

      @NotNull public @NotNull org.aya.util.reporter.Problem.Severity level()
      Specified by:
      level in interface org.aya.util.reporter.Problem

    • stage

      @NotNull public @NotNull org.aya.util.reporter.Problem.Stage stage()
      Specified by:
      stage in interface org.aya.util.reporter.Problem

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

    • state

      @NotNull public @NotNull TyckState state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component

    • hole

      @NotNull public @NotNull MetaTerm hole()
      Returns the value of the hole record component.
      Returns:
      the value of the hole record component

    • scope

      @NotNull public @NotNull kala.collection.immutable.ImmutableSeq<LocalVar> scope()
      Returns the value of the scope record component.
      Returns:
      the value of the scope record component