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

Record Class HighlightInfo.SymDef

java.lang.Object
java.lang.Record
org.aya.cli.literate.HighlightInfo.SymDef
All Implemented Interfaces:
HighlightInfo.HighlightSymbol
Enclosing class:
HighlightInfo
public static record HighlightInfo.SymDef(@NotNull org.aya.pretty.doc.Link target, @NotNull HighlightInfo.DefKind kind, @Nullable org.aya.generic.AyaDocile type) extends Record implements HighlightInfo.HighlightSymbol
A definition of a symbol

  • Constructor Summary

    Constructors
    Constructor
    Description
    SymDef(@NotNull org.aya.pretty.doc.Link target, @NotNull HighlightInfo.DefKind kind, @Nullable org.aya.generic.AyaDocile type)
    Creates an instance of a SymDef record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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 HighlightInfo.DefKind
    kind()
    Returns the value of the kind record component.
    @NotNull org.aya.pretty.doc.Link
    target()
    Returns the value of the target record component.
    final String
    toString()
    Returns a string representation of this record class.
    @Nullable org.aya.generic.AyaDocile
    type()
    Returns the value of the type record component.

    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

    • SymDef

      public SymDef(@NotNull @NotNull org.aya.pretty.doc.Link target, @NotNull @NotNull HighlightInfo.DefKind kind, @Nullable @Nullable org.aya.generic.AyaDocile type)
      Creates an instance of a SymDef record class.
      Parameters:
      target - the value for the target record component
      kind - the value for the kind record component
      type - the value for the type 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.

    • target

      @NotNull public @NotNull org.aya.pretty.doc.Link target()
      Returns the value of the target record component.
      Returns:
      the value of the target record component

    • kind

      @NotNull public @NotNull HighlightInfo.DefKind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • type

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