Package org.asciidoctor.jruby.ast.impl

Class FootnoteImpl

  • All Implemented Interfaces:
    Footnote
    public class FootnoteImpl
extends java.lang.Object
implements Footnote

    • Constructor Summary

      Constructors 
      Constructor Description
      FootnoteImpl()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete 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.
      static Footnote getInstance​(java.lang.Long index, java.lang.String id, java.lang.String text)  
      static Footnote getInstance​(org.jruby.RubyStruct rubyFootnote)  
      java.lang.String getText()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • FootnoteImpl

        public FootnoteImpl()

    • Method Detail

      • getInstance

        public static Footnote getInstance​(java.lang.Long index,
                                   java.lang.String id,
                                   java.lang.String text)

      • getInstance

        public static Footnote getInstance​(org.jruby.RubyStruct rubyFootnote)

      • getIndex

        public java.lang.Long getIndex()
        Description copied from interface: Footnote
        The index is the number asciidoctor has assigned to the footnote. Footnotes start at 1 and are numbered consecutively throughout the document.
        Specified by:
        getIndex in interface Footnote
        Returns:
        footnote number

      • getId

        public java.lang.String getId()
        Description copied from interface: Footnote
        Each footnote can optionally have an id. Ids are used when a document author wants to reference a single footnote more than once.
        Specified by:
        getId in interface Footnote
        Returns:
        footnote id or null

      • getText

        public java.lang.String getText()
        Specified by:
        getText in interface Footnote
        Returns:
        the text the document author has specified for the footnote