Module aya.base
Package org.aya.concrete.remark

Record Class CodeOptions

java.lang.Object
java.lang.Record
org.aya.concrete.remark.CodeOptions
public record CodeOptions(@NotNull NormalizeMode mode, @NotNull org.aya.util.distill.DistillerOptions options, @NotNull CodeOptions.ShowCode showCode) extends Record

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    CodeOptions.ShowCode
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NotNull CodeOptions
    DEFAULT
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CodeOptions(@NotNull NormalizeMode mode, @NotNull org.aya.util.distill.DistillerOptions options, @NotNull CodeOptions.ShowCode showCode)
    Creates an instance of a CodeOptions record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull Literate
    analyze(@NotNull org.commonmark.node.Code code, @NotNull org.aya.util.error.SourcePos sourcePos)
     
    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 NormalizeMode
    mode()
    Returns the value of the mode record component.
    @NotNull org.aya.util.distill.DistillerOptions
    options()
    Returns the value of the options record component.
    @NotNull CodeOptions.ShowCode
    showCode()
    Returns the value of the showCode 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

  • Field Details

    • DEFAULT

      @NotNull public static final @NotNull CodeOptions DEFAULT

  • Constructor Details

    • CodeOptions

      public CodeOptions(@NotNull @NotNull NormalizeMode mode, @NotNull @NotNull org.aya.util.distill.DistillerOptions options, @NotNull @NotNull CodeOptions.ShowCode showCode)
      Creates an instance of a CodeOptions record class.
      Parameters:
      mode - the value for the mode record component
      options - the value for the options record component
      showCode - the value for the showCode record component

  • Method Details

    • analyze

      @NotNull public static @NotNull Literate analyze(@NotNull @NotNull org.commonmark.node.Code code, @NotNull @NotNull org.aya.util.error.SourcePos sourcePos)

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

    • mode

      @NotNull public @NotNull NormalizeMode mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component

    • options

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

    • showCode

      @NotNull public @NotNull CodeOptions.ShowCode showCode()
      Returns the value of the showCode record component.
      Returns:
      the value of the showCode record component