Package org.asciidoctor.jruby.ast.impl

Class FootnoteImpl

java.lang.Object

org.asciidoctor.jruby.ast.impl.FootnoteImpl

All Implemented Interfaces:

Footnote

public class FootnoteImpl
extends Object
implements Footnote

Constructor Summary

Constructors

Constructor	Description
FootnoteImpl()

Method Summary

Modifier and Type	Method	Description
String	getId()	Each footnote can optionally have an id.
Long	getIndex()	The index is the number asciidoctor has assigned to the footnote.
static Footnote	getInstance(Long index, String id, String text)
static Footnote	getInstance(org.jruby.RubyStruct rubyFootnote)
String	getText()

Methods inherited from class java.lang.Object

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

Constructor Details

FootnoteImpl

public FootnoteImpl()

Method Details

getInstance

public static Footnote getInstance(Long index,
 String id,
 String text)

getInstance

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

getIndex

public 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 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 String getText()

Specified by:

getText in interface Footnote

Returns:

the text the document author has specified for the footnote