Package org.asciidoctor.ast

Interface Document

All Superinterfaces:

ContentNode, StructuralNode

All Known Implementing Classes:

DocumentImpl

public interface Document
extends StructuralNode

Field Summary

Fields inherited from interface org.asciidoctor.ast.StructuralNode

SUBSTITUTION_ATTRIBUTES, SUBSTITUTION_MACROS, SUBSTITUTION_POST_REPLACEMENTS, SUBSTITUTION_QUOTES, SUBSTITUTION_REPLACEMENTS, SUBSTITUTION_SPECIAL_CHARACTERS

Method Summary

Modifier and Type	Method	Description
boolean	basebackend(String backend)	Deprecated. Please use isBasebackend(String)
String	doctitle()	Deprecated. Please use getDoctitle()
int	getAndIncrementCounter(String name)	Gets the current counter with the given name and increases its value.
int	getAndIncrementCounter(String name, int initialValue)	Gets the current counter with the given name and increases its value.
List<Author>	getAuthors()	Gets the author(s) information as defined in the author line in the document header, or in author & email attributes.
Catalog	getCatalog()	The catalog contains data collected by asciidoctor that is useful to a converter.
String	getDoctitle()
Map<Object,Object>	getOptions()
RevisionInfo	getRevisionInfo()	The revision information with: date, number and remark.
Title	getStructuredDoctitle()
boolean	isBasebackend(String backend)
boolean	isSourcemap()
void	setSourcemap(boolean state)	Toggles the sourcemap option.

Methods inherited from interface org.asciidoctor.ast.ContentNode

addRole, context, document, getAttr, getAttr, getAttr, getAttribute, getAttribute, getAttribute, getAttributes, getContext, getDocument, getId, getNodeName, getParent, getReftext, getRole, getRoles, hasAttr, hasAttr, hasAttribute, hasAttribute, hasRole, iconUri, id, imageUri, imageUri, isAttr, isAttr, isAttribute, isAttribute, isBlock, isInline, isOption, isReftext, isRole, mediaUri, normalizeWebPath, parent, readAsset, removeRole, role, setAttr, setAttribute, setId

Methods inherited from interface org.asciidoctor.ast.StructuralNode

addSubstitution, append, blocks, content, convert, findBy, getBlocks, getCaption, getContent, getContentModel, getLevel, getSourceLocation, getStyle, getSubstitutions, getTitle, isSubstitutionEnabled, prependSubstitution, removeSubstitution, setCaption, setLevel, setStyle, setSubstitutions, setTitle, style, title

Method Details

getStructuredDoctitle

Title getStructuredDoctitle()

Returns:

The Title structure for this document.

See Also:

• Title

getDoctitle

String getDoctitle()

Returns:

The title as a String.

See Also:

• Title

doctitle

@Deprecated
String doctitle()

Deprecated.

Please use getDoctitle()

Returns:

The title as a String.

See Also:

• Title

getAuthors

List<Author> getAuthors()

Gets the author(s) information as defined in the author line in the document header, or in author & email attributes.

Returns:

authors information

isBasebackend

boolean isBasebackend(String backend)

Returns:

basebackend attribute value

basebackend

@Deprecated
boolean basebackend(String backend)

Deprecated.

Please use isBasebackend(String)

Returns:

basebackend attribute value

getOptions

Map<Object,Object> getOptions()

Returns:

options defined in document.

getAndIncrementCounter

int getAndIncrementCounter(String name)

Gets the current counter with the given name and increases its value. At the first invocation the counter will return 1. After the call the value of the counter is set to the returned value plus 1.

Parameters:

name -

Returns:

getAndIncrementCounter

int getAndIncrementCounter(String name,
 int initialValue)

Gets the current counter with the given name and increases its value. At the first invocation the counter will return the given initial value. After the call the value of the counter is set to the returned value plus 1.

Parameters:

name -

initialValue -

Returns:

isSourcemap

boolean isSourcemap()

Returns:

Whether the sourcemap is enabled.

setSourcemap

void setSourcemap(boolean state)

Toggles the sourcemap option. This method must be called before the document is parsed, such as from a Preprocessor extension. Otherwise, it has no effect.

Parameters:

state - The state in which to put the sourcemap (true = on, false = off).

getCatalog

Catalog getCatalog()

The catalog contains data collected by asciidoctor that is useful to a converter. Note that the catalog is not part of the asciidoctor public API and is subject to change.

Returns:

catalog

getRevisionInfo

RevisionInfo getRevisionInfo()

The revision information with: date, number and remark.

Returns:

revisionInfo