Package org.asciidoctor.ast

Interface StructuralNode

All Superinterfaces:

ContentNode

All Known Subinterfaces:

Block, DescriptionList, Document, List, ListItem, Section, Table

All Known Implementing Classes:

BlockImpl, DescriptionListEntryImpl, DescriptionListImpl, DocumentImpl, ListImpl, ListItemImpl, SectionImpl, StructuralNodeImpl, TableImpl

public interface StructuralNode
extends ContentNode

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUBSTITUTION_ATTRIBUTES	Constant for attribute replacements like {foo}.
static final String	SUBSTITUTION_MACROS	Constant for macro replacements like mymacro:target[].
static final String	SUBSTITUTION_POST_REPLACEMENTS	Constant for post replacements like creating line breaks from a trailing + in a line.
static final String	SUBSTITUTION_QUOTES	Constant for quote replacements like *bold* to bold.
static final String	SUBSTITUTION_REPLACEMENTS	Constant for replacements like (C) to ©.
static final String	SUBSTITUTION_SPECIAL_CHARACTERS	Constant for special character replacement substitution like < to &amp;lt;.

Method Summary

Modifier and Type	Method	Description
void	addSubstitution(String substitution)	Adds the given substitution to this node at the end of the substitution list.
void	append(StructuralNode block)	Appends a new child block as the last block to this block.
List<StructuralNode>	blocks()	Deprecated. Please use getBlocks() instead
Object	content()	Deprecated. Please use getContent() instead
String	convert()
List<StructuralNode>	findBy(Map<Object,Object> selector)
List<StructuralNode>	getBlocks()
String	getCaption()
Object	getContent()
String	getContentModel()	Returns the content model.
int	getLevel()
Cursor	getSourceLocation()	Returns the source location of this block.
String	getStyle()
List<String>	getSubstitutions()	Returns the list of enabled substitutions.
String	getTitle()
boolean	isSubstitutionEnabled(String substitution)
void	prependSubstitution(String substitution)	Adds the given substitution to this node at the beginning of the substitution list.
void	removeSubstitution(String substitution)	Removes the given substitution from this node.
void	setCaption(String caption)
void	setLevel(int level)
void	setStyle(String style)
void	setSubstitutions(String... substitution)	Sets the given substitutions on this node overwriting all other substitutions.
void	setTitle(String title)
String	style()	Deprecated. Please use getStyle() instead
String	title()	Deprecated. Please use getTitle() instead

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

Field Details

SUBSTITUTION_SPECIAL_CHARACTERS

static final String SUBSTITUTION_SPECIAL_CHARACTERS

Constant for special character replacement substitution like < to <.

See Also:

• Asciidoctor User Manual
• Constant Field Values

SUBSTITUTION_QUOTES

static final String SUBSTITUTION_QUOTES

Constant for quote replacements like *bold* to bold.

See Also:

• Asciidoctor User Manual
• Constant Field Values

SUBSTITUTION_ATTRIBUTES

static final String SUBSTITUTION_ATTRIBUTES

Constant for attribute replacements like {foo}.

See Also:

• Asciidoctor User Manual
• Constant Field Values

SUBSTITUTION_REPLACEMENTS

static final String SUBSTITUTION_REPLACEMENTS

Constant for replacements like (C) to ©.

See Also:

• Asciidoctor User Manual
• Constant Field Values

SUBSTITUTION_MACROS

static final String SUBSTITUTION_MACROS

Constant for macro replacements like mymacro:target[].

See Also:

• Asciidoctor User Manual
• Constant Field Values

SUBSTITUTION_POST_REPLACEMENTS

static final String SUBSTITUTION_POST_REPLACEMENTS

Constant for post replacements like creating line breaks from a trailing + in a line.

See Also:

• Asciidoctor User Manual
• Constant Field Values

Method Details

title

@Deprecated
String title()

Deprecated.

Please use getTitle() instead

getTitle

String getTitle()

setTitle

void setTitle(String title)

getCaption

String getCaption()

setCaption

void setCaption(String caption)

style

@Deprecated
String style()

Deprecated.

Please use getStyle() instead

getStyle

String getStyle()

setStyle

void setStyle(String style)

blocks

@Deprecated
List<StructuralNode> blocks()

Deprecated.

Please use getBlocks() instead

Returns:

The list of child blocks of this block

getBlocks

List<StructuralNode> getBlocks()

Returns:

The list of child blocks of this block

append

void append(StructuralNode block)

Appends a new child block as the last block to this block.

Parameters:

block - The new child block added as last child to this block.

content

@Deprecated
Object content()

Deprecated.

Please use getContent() instead

getContent

Object getContent()

convert

String convert()

findBy

List<StructuralNode> findBy(Map<Object,Object> selector)

getLevel

int getLevel()

setLevel

void setLevel(int level)

getContentModel

String getContentModel()

Returns the content model.

Returns:

the content model

See Also:

• ContentModel

getSourceLocation

Cursor getSourceLocation()

Returns the source location of this block. This information is only available if the sourcemap option is enabled when loading or rendering the document.

Returns:

the source location of this block or null if the sourcemap option is not enabled when loading the document.

getSubstitutions

List<String> getSubstitutions()

Returns the list of enabled substitutions.

Returns:

A list of substitutions enabled for this node, e.g. ["specialcharacters", "quotes", "attributes", "replacements", "macros", "post_replacements"] for paragraphs.

See Also:

• Asciidoctor User Manual

isSubstitutionEnabled

boolean isSubstitutionEnabled(String substitution)

Parameters:

substitution - the name of a substitution, e.g. SUBSTITUTION_POST_REPLACEMENTS

Returns:

true if the name of the given substitution is enabled.

See Also:

• Asciidoctor User Manual

removeSubstitution

void removeSubstitution(String substitution)

Removes the given substitution from this node.

Parameters:

substitution - the name of a substitution, e.g. SUBSTITUTION_QUOTES

See Also:

• Asciidoctor User Manual

addSubstitution

void addSubstitution(String substitution)

Adds the given substitution to this node at the end of the substitution list.

Parameters:

substitution - the name of a substitution, e.g. SUBSTITUTION_MACROS

See Also:

• Asciidoctor User Manual

prependSubstitution

void prependSubstitution(String substitution)

Adds the given substitution to this node at the beginning of the substitution list.

Parameters:

substitution - the name of a substitution, e.g. SUBSTITUTION_ATTRIBUTES

See Also:

• Asciidoctor User Manual

setSubstitutions

void setSubstitutions(String... substitution)

Sets the given substitutions on this node overwriting all other substitutions.

Parameters:

substitution - the name of a substitution, e.g. SUBSTITUTION_SPECIAL_CHARACTERS

See Also:

• Asciidoctor User Manual