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

Record Class FaithfulPrettier

java.lang.Object
java.lang.Record
org.aya.cli.literate.FaithfulPrettier
public record FaithfulPrettier(@NotNull org.aya.util.prettier.PrettierOptions options) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    FaithfulPrettier(@NotNull org.aya.util.prettier.PrettierOptions options)
    Creates an instance of a FaithfulPrettier 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 org.aya.pretty.doc.Doc
    highlight(@NotNull String raw, int base, @NotNull kala.collection.immutable.ImmutableSeq<HighlightInfo> highlights)
    Apply highlights to source code string.
    @NotNull org.aya.util.prettier.PrettierOptions
    options()
    Returns the value of the options record component.
    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

  • Constructor Details

    • FaithfulPrettier

      public FaithfulPrettier(@NotNull @NotNull org.aya.util.prettier.PrettierOptions options)
      Creates an instance of a FaithfulPrettier record class.
      Parameters:
      options - the value for the options record component

  • Method Details

    • highlight

      @NotNull public @NotNull org.aya.pretty.doc.Doc highlight(@NotNull @NotNull String raw, int base, @NotNull @NotNull kala.collection.immutable.ImmutableSeq<HighlightInfo> highlights)
      Apply highlights to source code string.
      Parameters:
      raw - the source code
      base - where the raw start from (the 'raw' might be a piece of the source code, so it probably not starts from 0).
      highlights - the highlights for the source code

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

    • options

      @NotNull public @NotNull org.aya.util.prettier.PrettierOptions options()
      Returns the value of the options record component.
      Returns:
      the value of the options record component