Module aya.pretty
Package org.aya.pretty.error

Record Class PrettyError.FormatConfig

java.lang.Object
java.lang.Record
org.aya.pretty.error.PrettyError.FormatConfig
Enclosing class:
PrettyError
public static record PrettyError.FormatConfig(@NotNull kala.control.Option<Character> vbarForHints, char lineNoSeparator, @NotNull kala.control.Option<Character> errorIndicator, char underlineBegin, char underlineEnd, char underlineBody, char beginCorner, char endCorner) extends Record

  • Field Details

  • Constructor Details

    • FormatConfig

      public FormatConfig(@NotNull @NotNull kala.control.Option<Character> vbarForHints, char lineNoSeparator, @NotNull @NotNull kala.control.Option<Character> errorIndicator, char underlineBegin, char underlineEnd, char underlineBody, char beginCorner, char endCorner)
      Creates an instance of a FormatConfig record class.
      Parameters:
      vbarForHints - the value for the vbarForHints record component
      lineNoSeparator - the value for the lineNoSeparator record component
      errorIndicator - the value for the errorIndicator record component
      underlineBegin - the value for the underlineBegin record component
      underlineEnd - the value for the underlineEnd record component
      underlineBody - the value for the underlineBody record component
      beginCorner - the value for the beginCorner record component
      endCorner - the value for the endCorner record component

  • Method Details

    • underlineBody

      @NotNull public @NotNull String underlineBody(int n)

    • underlineBodyDoc

      @NotNull public @NotNull Doc underlineBodyDoc(int n)

    • lineNoSepDoc

      @NotNull public @NotNull Doc lineNoSepDoc()

    • beginCornerDoc

      @NotNull public @NotNull Doc beginCornerDoc()

    • endCornerDoc

      @NotNull public @NotNull Doc endCornerDoc()

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

    • vbarForHints

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

    • lineNoSeparator

      public char lineNoSeparator()
      Returns the value of the lineNoSeparator record component.
      Returns:
      the value of the lineNoSeparator record component

    • errorIndicator

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

    • underlineBegin

      public char underlineBegin()
      Returns the value of the underlineBegin record component.
      Returns:
      the value of the underlineBegin record component

    • underlineEnd

      public char underlineEnd()
      Returns the value of the underlineEnd record component.
      Returns:
      the value of the underlineEnd record component

    • underlineBody

      public char underlineBody()
      Returns the value of the underlineBody record component.
      Returns:
      the value of the underlineBody record component

    • beginCorner

      public char beginCorner()
      Returns the value of the beginCorner record component.
      Returns:
      the value of the beginCorner record component

    • endCorner

      public char endCorner()
      Returns the value of the endCorner record component.
      Returns:
      the value of the endCorner record component