Module aya.cli.impl
Package org.aya.cli.literate

Record Class HighlightInfo.SymError

java.lang.Object
java.lang.Record
org.aya.cli.literate.HighlightInfo.SymError
All Implemented Interfaces:
HighlightInfo.HighlightSymbol
Enclosing class:
HighlightInfo
public static record HighlightInfo.SymError(@NotNull org.aya.generic.AyaDocile docile) extends Record implements HighlightInfo.HighlightSymbol
An error element

  • Constructor Summary

    Constructors
    Constructor
    Description
    SymError(@NotNull org.aya.generic.AyaDocile docile)
    Creates an instance of a SymError record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull org.aya.generic.AyaDocile
    docile()
    Returns the value of the docile record component.
    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.
    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.cli.literate.HighlightInfo.HighlightSymbol

    toInfo

  • Constructor Details

    • SymError

      public SymError(@NotNull @NotNull org.aya.generic.AyaDocile docile)
      Creates an instance of a SymError record class.
      Parameters:
      docile - the value for the docile record component

  • Method Details

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

    • docile

      @NotNull public @NotNull org.aya.generic.AyaDocile docile()
      Returns the value of the docile record component.
      Returns:
      the value of the docile record component