org.asciidoctor.ast.impl

Class StructuralNodeImpl

java.lang.Object

org.asciidoctor.internal.RubyObjectWrapper

org.asciidoctor.ast.impl.ContentNodeImpl

org.asciidoctor.ast.impl.StructuralNodeImpl

All Implemented Interfaces:

ContentNode, StructuralNode

Direct Known Subclasses:

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

public class StructuralNodeImpl
extends ContentNodeImpl
implements StructuralNode

Field Summary

Fields inherited from class org.asciidoctor.internal.RubyObjectWrapper

rubyNode, runtime

Fields inherited from interface org.asciidoctor.ast.StructuralNode

SUBSTITUTION_ATTRIBUTES, SUBSTITUTION_MACROS, SUBSTITUTION_POST_REPLACEMENTS, SUBSTITUTION_QUOTES, SUBSTITUTION_REPLACEMENTS, SUBSTITUTION_SPECIAL_CHARACTERS

Constructor Summary

Constructors

Constructor and Description
StructuralNodeImpl(org.jruby.runtime.builtin.IRubyObject blockDelegate)

Method Summary

Modifier and Type	Method and Description
void	addSubstitution(java.lang.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.
java.util.List<StructuralNode>	blocks() Deprecated.
java.lang.Object	content() Deprecated.
java.lang.String	convert()
java.util.List<StructuralNode>	findBy(java.util.Map<java.lang.Object,java.lang.Object> selector)
java.util.List<StructuralNode>	getBlocks()
java.lang.String	getCaption()
java.lang.Object	getContent()
java.lang.String	getContentModel() Returns the content model.
int	getLevel()
Cursor	getSourceLocation() Returns the source location of this block.
java.lang.String	getStyle()
java.util.List<java.lang.String>	getSubstitutions() Returns the list of enabled substitutions.
java.lang.String	getTitle()
boolean	isSubstitutionEnabled(java.lang.String substitution)
void	prependSubstitution(java.lang.String substitution) Adds the given substitution to this node at the beginning of the substitution list.
void	removeSubstitution(java.lang.String substitution) Removes the given substitution from this node.
void	setCaption(java.lang.String caption)
void	setStyle(java.lang.String style)
void	setSubstitutions(java.lang.String... substitutions) Sets the given substitutions on this node overwriting all other substitutions.
void	setTitle(java.lang.String title)
java.lang.String	style() Deprecated.
java.lang.String	title() Deprecated.

Methods inherited from class org.asciidoctor.ast.impl.ContentNodeImpl

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 class org.asciidoctor.internal.RubyObjectWrapper

getBoolean, getInt, getList, getProperty, getRubyObject, getRubyProperty, getRuntime, getString, getSymbol, setBoolean, setRubyProperty, setString, setSymbol, toJava, toJava

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.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

Constructor Detail

StructuralNodeImpl

public StructuralNodeImpl(org.jruby.runtime.builtin.IRubyObject blockDelegate)

Method Detail

title

@Deprecated
public java.lang.String title()

Deprecated.

Specified by:

title in interface StructuralNode

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface StructuralNode

setTitle

public void setTitle(java.lang.String title)

Specified by:

setTitle in interface StructuralNode

getCaption

public java.lang.String getCaption()

Specified by:

getCaption in interface StructuralNode

setCaption

public void setCaption(java.lang.String caption)

Specified by:

setCaption in interface StructuralNode

style

@Deprecated
public java.lang.String style()

Deprecated.

Specified by:

style in interface StructuralNode

getStyle

public java.lang.String getStyle()

Specified by:

getStyle in interface StructuralNode

setStyle

public void setStyle(java.lang.String style)

Specified by:

setStyle in interface StructuralNode

blocks

@Deprecated
public java.util.List<StructuralNode> blocks()

Deprecated.

Specified by:

blocks in interface StructuralNode

Returns:

The list of child blocks of this block

getBlocks

public java.util.List<StructuralNode> getBlocks()

Specified by:

getBlocks in interface StructuralNode

Returns:

The list of child blocks of this block

append

public void append(StructuralNode block)

Description copied from interface: StructuralNode

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

Specified by:

append in interface StructuralNode

Parameters:

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

content

@Deprecated
public java.lang.Object content()

Deprecated.

Specified by:

content in interface StructuralNode

getContent

public java.lang.Object getContent()

Specified by:

getContent in interface StructuralNode

convert

public java.lang.String convert()

Specified by:

convert in interface StructuralNode

getLevel

public int getLevel()

Specified by:

getLevel in interface StructuralNode

getSourceLocation

public Cursor getSourceLocation()

Description copied from interface: StructuralNode

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

Specified by:

getSourceLocation in interface StructuralNode

Returns:

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

getContentModel

public java.lang.String getContentModel()

Description copied from interface: StructuralNode

Returns the content model.

Specified by:

getContentModel in interface StructuralNode

Returns:

the content model

See Also:

ContentModel

getSubstitutions

public java.util.List<java.lang.String> getSubstitutions()

Description copied from interface: StructuralNode

Returns the list of enabled substitutions.

Specified by:

getSubstitutions in interface StructuralNode

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

public boolean isSubstitutionEnabled(java.lang.String substitution)

Specified by:

isSubstitutionEnabled in interface StructuralNode

Parameters:

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

Returns:

true if the name of the given substitution is enabled.

See Also:

Asciidoctor User Manual

removeSubstitution

public void removeSubstitution(java.lang.String substitution)

Description copied from interface: StructuralNode

Removes the given substitution from this node.

Specified by:

removeSubstitution in interface StructuralNode

Parameters:

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

See Also:

Asciidoctor User Manual

addSubstitution

public void addSubstitution(java.lang.String substitution)

Description copied from interface: StructuralNode

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

Specified by:

addSubstitution in interface StructuralNode

Parameters:

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

See Also:

Asciidoctor User Manual

prependSubstitution

public void prependSubstitution(java.lang.String substitution)

Description copied from interface: StructuralNode

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

Specified by:

prependSubstitution in interface StructuralNode

Parameters:

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

See Also:

Asciidoctor User Manual

setSubstitutions

public void setSubstitutions(java.lang.String... substitutions)

Description copied from interface: StructuralNode

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

Specified by:

setSubstitutions in interface StructuralNode

Parameters:

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

See Also:

Asciidoctor User Manual

findBy

public java.util.List<StructuralNode> findBy(java.util.Map<java.lang.Object,java.lang.Object> selector)

Specified by:

findBy in interface StructuralNode