Package org.asciidoctor.jruby.ast.impl
Class DocumentImpl
- java.lang.Object
-
- org.asciidoctor.jruby.internal.RubyObjectWrapper
-
- org.asciidoctor.jruby.ast.impl.ContentNodeImpl
-
- org.asciidoctor.jruby.ast.impl.StructuralNodeImpl
-
- org.asciidoctor.jruby.ast.impl.DocumentImpl
-
- All Implemented Interfaces:
ContentNode
,Document
,StructuralNode
public class DocumentImpl extends StructuralNodeImpl implements Document
-
-
Field Summary
-
Fields inherited from class org.asciidoctor.jruby.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 Description DocumentImpl(org.jruby.runtime.builtin.IRubyObject document)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
basebackend(java.lang.String backend)
Deprecated.java.lang.String
doctitle()
Deprecated.int
getAndIncrementCounter(java.lang.String name)
Gets the current counter with the given name and increases its value.int
getAndIncrementCounter(java.lang.String name, int initialValue)
Gets the current counter with the given name and increases its value.java.util.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.java.lang.String
getDoctitle()
java.util.Map<java.lang.Object,java.lang.Object>
getOptions()
RevisionInfo
getRevisionInfo()
The revision information with: date, number and remark.Title
getStructuredDoctitle()
boolean
isBasebackend(java.lang.String backend)
boolean
isSourcemap()
void
setSourcemap(boolean state)
Toggles the sourcemap option.-
Methods inherited from class org.asciidoctor.jruby.ast.impl.StructuralNodeImpl
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
-
Methods inherited from class org.asciidoctor.jruby.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.jruby.internal.RubyObjectWrapper
getBoolean, getInt, getList, getProperty, getRubyObject, getRubyProperty, getRuntime, getString, getSymbol, setBoolean, setInt, 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
-
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 Detail
-
isBasebackend
public boolean isBasebackend(java.lang.String backend)
- Specified by:
isBasebackend
in interfaceDocument
- Returns:
- basebackend attribute value
-
basebackend
@Deprecated public boolean basebackend(java.lang.String backend)
Deprecated.- Specified by:
basebackend
in interfaceDocument
- Returns:
- basebackend attribute value
-
getOptions
public java.util.Map<java.lang.Object,java.lang.Object> getOptions()
- Specified by:
getOptions
in interfaceDocument
- Returns:
- options defined in document.
-
getStructuredDoctitle
public Title getStructuredDoctitle()
- Specified by:
getStructuredDoctitle
in interfaceDocument
- Returns:
- The Title structure for this document.
- See Also:
Title
-
getDoctitle
public java.lang.String getDoctitle()
- Specified by:
getDoctitle
in interfaceDocument
- Returns:
- The title as a String.
- See Also:
Title
-
doctitle
@Deprecated public java.lang.String doctitle()
Deprecated.
-
getAuthors
public java.util.List<Author> getAuthors()
Description copied from interface:Document
Gets the author(s) information as defined in the author line in the document header, or in author & email attributes.- Specified by:
getAuthors
in interfaceDocument
- Returns:
- authors information
-
getAndIncrementCounter
public int getAndIncrementCounter(java.lang.String name)
Description copied from interface:Document
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.- Specified by:
getAndIncrementCounter
in interfaceDocument
- Returns:
-
getAndIncrementCounter
public int getAndIncrementCounter(java.lang.String name, int initialValue)
Description copied from interface:Document
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.- Specified by:
getAndIncrementCounter
in interfaceDocument
- Returns:
-
isSourcemap
public boolean isSourcemap()
- Specified by:
isSourcemap
in interfaceDocument
- Returns:
- Whether the sourcemap is enabled.
-
setSourcemap
public void setSourcemap(boolean state)
Description copied from interface:Document
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.- Specified by:
setSourcemap
in interfaceDocument
- Parameters:
state
- The state in which to put the sourcemap (true = on, false = off).
-
getCatalog
public Catalog getCatalog()
Description copied from interface:Document
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.- Specified by:
getCatalog
in interfaceDocument
- Returns:
- catalog
-
getRevisionInfo
public RevisionInfo getRevisionInfo()
Description copied from interface:Document
The revision information with: date, number and remark.- Specified by:
getRevisionInfo
in interfaceDocument
- Returns:
- revisionInfo
-
-