Module aya.base
Package org.aya.core.term

Record Class ErrorTerm

java.lang.Object
java.lang.Record
org.aya.core.term.ErrorTerm
Record Components:
isReallyError - true if this is indeed an error, false if this is just for pretty printing placeholder
All Implemented Interfaces:
StableWHNF, Term, AyaDocile, org.aya.guest0x0.cubical.Restr.TermLike<Term>
public record ErrorTerm(@NotNull AyaDocile description, boolean isReallyError) extends Record implements StableWHNF
See Also:

  • Constructor Details

    • ErrorTerm

      public ErrorTerm(@NotNull @NotNull Term description)

    • ErrorTerm

      public ErrorTerm(@NotNull @NotNull AyaDocile description)

    • ErrorTerm

      public ErrorTerm(@NotNull @NotNull org.aya.pretty.doc.Doc description, boolean isReallyError)

    • ErrorTerm

      public ErrorTerm(@NotNull @NotNull AyaDocile description, boolean isReallyError)
      Creates an instance of a ErrorTerm record class.
      Parameters:
      description - the value for the description record component
      isReallyError - the value for the isReallyError record component

  • Method Details

    • typeOf

      @NotNull public static @NotNull ErrorTerm typeOf(@NotNull @NotNull Term origin)

    • typeOf

      @NotNull public static @NotNull ErrorTerm typeOf(@NotNull @NotNull AyaDocile origin)

    • unexpected

      @NotNull public static @NotNull ErrorTerm unexpected(@NotNull @NotNull AyaDocile origin)

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

    • description

      @NotNull public @NotNull AyaDocile description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • isReallyError

      public boolean isReallyError()
      Returns the value of the isReallyError record component.
      Returns:
      the value of the isReallyError record component