Package org.asciidoctor.jruby.ast.impl

Class CatalogImpl

java.lang.Object

org.asciidoctor.jruby.ast.impl.CatalogImpl

All Implemented Interfaces:

Catalog

public class CatalogImpl
extends Object
implements Catalog

Constructor Summary

Constructors

Constructor	Description
CatalogImpl(Map<String,Object> catalog)

Method Summary

Modifier and Type	Method	Description
List<Footnote>	getFootnotes()	Note that footnotes are only available after `Document.getContent()` has been called.
Map<String,Object>	getRefs()	Refs is a map of asciidoctor ids to asciidoctor document elements.

Methods inherited from class java.lang.Object

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

Constructor Details

CatalogImpl

public CatalogImpl(Map<String,Object> catalog)

Method Details

getFootnotes

public List<Footnote> getFootnotes()

Description copied from interface: Catalog

Note that footnotes are only available after `Document.getContent()` has been called. A converter uses cataloged footnotes to render them, presumably, at the bottom of a document.

Specified by:

getFootnotes in interface Catalog

Returns:

footnotes occurring in document.

getRefs

public Map<String,Object> getRefs()

Description copied from interface: Catalog

Refs is a map of asciidoctor ids to asciidoctor document elements. For example, by default, each section is automatically assigned an id. In this case the id would map to a Section element. Ids can also be explicitly assigned by document authors to any document element. See https://asciidoctor.org/docs/user-manual/#id A converter might use cataloged refs to lookup ids to support rendering inline anchors.

Specified by:

getRefs in interface Catalog

Returns:

a map of ids to elements that asciidoctor has collected from the document.