Module aya.cli.impl
Package org.aya.cli.single

Record Class SingleAyaFile.MarkdownAyaFile

java.lang.Object
java.lang.Record
org.aya.cli.single.SingleAyaFile.MarkdownAyaFile
All Implemented Interfaces:
SingleAyaFile, org.aya.concrete.GenericAyaFile
Enclosing interface:
SingleAyaFile
public static record SingleAyaFile.MarkdownAyaFile(@NotNull org.aya.util.error.SourceFile originalFile, @NotNull org.aya.cli.single.SingleAyaFile.MarkdownAyaFile.Data data) extends Record implements SingleAyaFile

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.aya.cli.single.SingleAyaFile

    SingleAyaFile.CodeAyaFile, SingleAyaFile.Factory, SingleAyaFile.MarkdownAyaFile

  • Constructor Summary

    Constructors
    Constructor
    Description
    MarkdownAyaFile(@NotNull org.aya.util.error.SourceFile originalFile, @NotNull org.aya.cli.single.SingleAyaFile.MarkdownAyaFile.Data data)
    Creates an instance of a MarkdownAyaFile record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull org.aya.util.error.SourceFile
    codeFile()
     
    @NotNull org.aya.cli.single.SingleAyaFile.MarkdownAyaFile.Data
    data()
    Returns the value of the data 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.
    @NotNull org.aya.concrete.remark.Literate
    literate()
     
    @NotNull org.aya.util.error.SourceFile
    originalFile()
    Returns the value of the originalFile record component.
    @NotNull kala.collection.immutable.ImmutableSeq<org.aya.concrete.stmt.Stmt>
    parseMe(@NotNull org.aya.concrete.GenericAyaParser parser)
     
    void
    resolveAdditional(@NotNull org.aya.resolve.ResolveInfo info)
    Must be called after GenericAyaFile.parseMe(org.aya.concrete.GenericAyaParser)
    final String
    toString()
    Returns a string representation of this record class.
    void
    tyckAdditional(@NotNull org.aya.resolve.ResolveInfo info)
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.aya.cli.single.SingleAyaFile

    pretty, toDoc

  • Constructor Details

    • MarkdownAyaFile

      public MarkdownAyaFile(@NotNull @NotNull org.aya.util.error.SourceFile originalFile, @NotNull @NotNull org.aya.cli.single.SingleAyaFile.MarkdownAyaFile.Data data)
      Creates an instance of a MarkdownAyaFile record class.
      Parameters:
      originalFile - the value for the originalFile record component
      data - the value for the data record component

  • Method Details

    • resolveAdditional

      public void resolveAdditional(@NotNull @NotNull org.aya.resolve.ResolveInfo info)
      Description copied from interface: SingleAyaFile
      Must be called after GenericAyaFile.parseMe(org.aya.concrete.GenericAyaParser)
      Specified by:
      resolveAdditional in interface SingleAyaFile

    • tyckAdditional

      public void tyckAdditional(@NotNull @NotNull org.aya.resolve.ResolveInfo info)
      Specified by:
      tyckAdditional in interface SingleAyaFile

    • parseMe

      @NotNull public @NotNull kala.collection.immutable.ImmutableSeq<org.aya.concrete.stmt.Stmt> parseMe(@NotNull @NotNull org.aya.concrete.GenericAyaParser parser) throws IOException
      Specified by:
      parseMe in interface org.aya.concrete.GenericAyaFile
      Throws:
      IOException

    • codeFile

      @NotNull public @NotNull org.aya.util.error.SourceFile codeFile()
      Specified by:
      codeFile in interface org.aya.concrete.GenericAyaFile

    • literate

      @NotNull public @NotNull org.aya.concrete.remark.Literate literate() throws IOException
      Specified by:
      literate in interface org.aya.concrete.GenericAyaFile
      Throws:
      IOException

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

    • originalFile

      @NotNull public @NotNull org.aya.util.error.SourceFile originalFile()
      Returns the value of the originalFile record component.
      Specified by:
      originalFile in interface org.aya.concrete.GenericAyaFile
      Returns:
      the value of the originalFile record component

    • data

      @NotNull public @NotNull org.aya.cli.single.SingleAyaFile.MarkdownAyaFile.Data data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component