Module aya.base
Package org.aya.core.pat

Record Class Pat.Preclause<T extends AyaDocile>

java.lang.Object
java.lang.Record
org.aya.core.pat.Pat.Preclause<T>
All Implemented Interfaces:
AyaDocile
Enclosing interface:
Pat
public static record Pat.Preclause<T extends AyaDocile>(@NotNull org.aya.util.error.SourcePos sourcePos, @NotNull kala.collection.immutable.ImmutableSeq<Pat> patterns, @NotNull kala.control.Option<T extends AyaDocile> expr) extends Record implements AyaDocile
It's 'pre' because there are also impossible clauses, which are removed after tycking.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Preclause(@NotNull org.aya.util.error.SourcePos sourcePos, @NotNull kala.collection.immutable.ImmutableSeq<Pat> patterns, @NotNull kala.control.Option<T> expr)
    Creates an instance of a Preclause record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @NotNull kala.control.Option<T>
    expr()
    Returns the value of the expr record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    static @NotNull kala.control.Option<@NotNull Term.Matching>
    lift(@NotNull Pat.Preclause<Term> clause)
     
    @NotNull kala.collection.immutable.ImmutableSeq<Pat>
    patterns()
    Returns the value of the patterns record component.
    @NotNull org.aya.util.error.SourcePos
    sourcePos()
    Returns the value of the sourcePos record component.
    @NotNull org.aya.pretty.doc.Doc
    toDoc(@NotNull org.aya.util.distill.DistillerOptions options)
     
    final String
    toString()
    Returns a string representation of this record class.
    static @NotNull Pat.Preclause<Term>
    weaken(Term.Matching clause)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.aya.generic.AyaDocile

    debuggerOnlyToDoc

  • Constructor Details

    • Preclause

      public Preclause(@NotNull @NotNull org.aya.util.error.SourcePos sourcePos, @NotNull @NotNull kala.collection.immutable.ImmutableSeq<Pat> patterns, @NotNull @NotNull kala.control.Option<T> expr)
      Creates an instance of a Preclause record class.
      Parameters:
      sourcePos - the value for the sourcePos record component
      patterns - the value for the patterns record component
      expr - the value for the expr record component

  • Method Details

    • toDoc

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

    • weaken

      @NotNull public static @NotNull Pat.Preclause<Term> weaken(@NotNull Term.Matching clause)

    • lift

      @NotNull public static @NotNull kala.control.Option<@NotNull Term.Matching> lift(@NotNull @NotNull Pat.Preclause<Term> clause)

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

    • sourcePos

      @NotNull public @NotNull org.aya.util.error.SourcePos sourcePos()
      Returns the value of the sourcePos record component.
      Returns:
      the value of the sourcePos record component

    • patterns

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

    • expr

      @NotNull public @NotNull kala.control.Option<T> expr()
      Returns the value of the expr record component.
      Returns:
      the value of the expr record component