Package org.asciidoctor.ast

Interface Footnote

  • All Known Implementing Classes:
    FootnoteImpl
    public interface Footnote

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getId()
      Each footnote can optionally have an id.
      java.lang.Long getIndex()
      The index is the number asciidoctor has assigned to the footnote.
      java.lang.String getText()  

    • Method Detail

      • getIndex

        java.lang.Long getIndex()
        The index is the number asciidoctor has assigned to the footnote. Footnotes start at 1 and are numbered consecutively throughout the document.
        Returns:
        footnote number

      • getId

        java.lang.String getId()
        Each footnote can optionally have an id. Ids are used when a document author wants to reference a single footnote more than once.
        Returns:
        footnote id or null

      • getText

        java.lang.String getText()
        Returns:
        the text the document author has specified for the footnote