org.asciidoctor.ast

Class Document

java.lang.Object

org.asciidoctor.ast.AbstractNodeImpl

org.asciidoctor.ast.AbstractBlockImpl

org.asciidoctor.ast.Document

All Implemented Interfaces:

AbstractBlock, AbstractNode, DocumentRuby

public class Document
extends AbstractBlockImpl
implements DocumentRuby

Field Summary

Fields inherited from class org.asciidoctor.ast.AbstractBlockImpl

delegate

Fields inherited from class org.asciidoctor.ast.AbstractNodeImpl

abstractNode, runtime

Constructor Summary

Constructors

Constructor and Description
Document(DocumentRuby documentRuby, org.jruby.Ruby runtime)

Method Summary

Modifier and Type	Method and Description
boolean	basebackend(java.lang.String backend)
java.lang.String	doctitle() Get doc title
java.lang.Object	doctitle(java.util.Map<java.lang.Object,java.lang.Object> opts) Get doc title
DocumentRuby	getDocumentRuby()
java.util.Map<java.lang.Object,java.lang.Object>	getOptions()

Methods inherited from class org.asciidoctor.ast.AbstractBlockImpl

blocks, content, convert, delegate, findBy, getBlocks, getCaption, getContent, getLevel, getNodeName, getSections, getStyle, getTitle, isBlocks, isSections, isTitle, style, title

Methods inherited from class org.asciidoctor.ast.AbstractNodeImpl

context, document, getAttr, getAttr, getAttr, getAttributes, getContext, getDocument, getParent, getReftext, getRole, getRoles, hasRole, iconUri, id, imageUri, imageUri, isAttr, isAttr, isBlock, isInline, isOption, isReftext, isRole, listMarkerKeyword, listMarkerKeyword, mediaUri, normalizeWebPath, parent, readAsset, role, setAttr

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.asciidoctor.ast.DocumentRuby

blocks, getAttributes, title

Methods inherited from interface org.asciidoctor.ast.AbstractBlock

content, convert, delegate, findBy, getBlocks, getContent, getLevel, getStyle, getTitle, style

Methods inherited from interface org.asciidoctor.ast.AbstractNode

context, document, getAttr, getAttr, getAttr, getContext, getDocument, getNodeName, getParent, getReftext, getRole, getRoles, hasRole, iconUri, id, imageUri, imageUri, isAttr, isAttr, isBlock, isInline, isOption, isReftext, isRole, listMarkerKeyword, listMarkerKeyword, mediaUri, normalizeWebPath, parent, readAsset, role, setAttr

Constructor Detail

Document

public Document(DocumentRuby documentRuby,
                org.jruby.Ruby runtime)

Method Detail

getDocumentRuby

public DocumentRuby getDocumentRuby()

basebackend

public boolean basebackend(java.lang.String backend)

Specified by:

basebackend in interface DocumentRuby

Returns:

basebackend attribute value

getOptions

public java.util.Map<java.lang.Object,java.lang.Object> getOptions()

Specified by:

getOptions in interface DocumentRuby

Returns:

options defined in document.

doctitle

public java.lang.Object doctitle(java.util.Map<java.lang.Object,java.lang.Object> opts)

Description copied from interface: DocumentRuby

Get doc title

Specified by:

doctitle in interface DocumentRuby

Parameters:

opts - to get the doc title. Key should be Ruby symbols.

Returns:

String if partition flag is not set to false or not present, Title if partition is set to true.

See Also:

Title

doctitle

public java.lang.String doctitle()

Description copied from interface: DocumentRuby

Get doc title

Specified by:

doctitle in interface DocumentRuby

Returns:

String if partition flag is not set to false or not present, Title if partition is set to true.

See Also:

Title