org.asciidoctor.ast.impl

Class DescriptionListEntryImpl

java.lang.Object

org.asciidoctor.internal.RubyObjectWrapper

org.asciidoctor.ast.impl.ContentNodeImpl

org.asciidoctor.ast.impl.StructuralNodeImpl

org.asciidoctor.ast.impl.DescriptionListEntryImpl

All Implemented Interfaces:

ContentNode, DescriptionListEntry, StructuralNode

public class DescriptionListEntryImpl
extends StructuralNodeImpl
implements DescriptionListEntry

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
DescriptionListEntryImpl(org.jruby.runtime.builtin.IRubyObject listDelegate)

Method Summary

Modifier and Type	Method and Description
ListItem	getDescription()
java.util.List<ListItem>	getTerms()
void	setDescription(ListItem description) Sets a new description for a description list item.

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

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

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

DescriptionListEntryImpl

public DescriptionListEntryImpl(org.jruby.runtime.builtin.IRubyObject listDelegate)

Method Detail

getTerms

public java.util.List<ListItem> getTerms()

Specified by:

getTerms in interface DescriptionListEntry

getDescription

public ListItem getDescription()

Specified by:

getDescription in interface DescriptionListEntry

setDescription

public void setDescription(ListItem description)

Description copied from interface: DescriptionListEntry

Sets a new description for a description list item. Description list items are ordinary ListItems and can be created using the factory methods of a processor:

 class MyTreeprocessor extends Treeprocessor() {
   public Document process(Document doc) {
     final String newDescription = "A new description for this entry.";
     DescriptionList dl = ...
     DescriptionListEntry dlEntry = ...
     dlEntry.setDescription(createListItem(dl, newDescription));
     return doc;
   }
 }

Specified by:

setDescription in interface DescriptionListEntry

Parameters:

description - The new description for this description list entry,