Package org.asciidoctor.extension

Class BaseProcessor

java.lang.Object

org.asciidoctor.extension.BaseProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

BlockProcessor, DocinfoProcessor, IncludeProcessor, MacroProcessor, Postprocessor, Preprocessor, Treeprocessor

public class BaseProcessor
extends java.lang.Object
implements Processor

Constructor Summary

Constructors

Constructor	Description
BaseProcessor()
BaseProcessor(java.util.Map<java.lang.String,java.lang.Object> config)

Method Summary

Modifier and Type	Method	Description
Block	createBlock(StructuralNode parent, java.lang.String context, java.lang.String content)
Block	createBlock(StructuralNode parent, java.lang.String context, java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> attributes)
Block	createBlock(StructuralNode parent, java.lang.String context, java.lang.String content, java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.Map<java.lang.Object,java.lang.Object> options)
Block	createBlock(StructuralNode parent, java.lang.String context, java.util.List<java.lang.String> content)
Block	createBlock(StructuralNode parent, java.lang.String context, java.util.List<java.lang.String> content, java.util.Map<java.lang.String,java.lang.Object> attributes)
Block	createBlock(StructuralNode parent, java.lang.String context, java.util.List<java.lang.String> content, java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.Map<java.lang.Object,java.lang.Object> options)
Block	createBlock(StructuralNode parent, java.lang.String context, java.util.Map<java.lang.Object,java.lang.Object> options)
Document	createDocument(Document parentDocument)	Creates an inner document for the given parent document.
List	createList(StructuralNode parent, java.lang.String context)	Creates a new List.
List	createList(StructuralNode parent, java.lang.String context, java.util.Map<java.lang.Object,java.lang.Object> options)	Creates a new List.
List	createList(StructuralNode parent, java.lang.String context, java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.Map<java.lang.Object,java.lang.Object> options)	Creates a new List.
ListItem	createListItem(DescriptionList parent, java.lang.String text)
ListItem	createListItem(List parent, java.lang.String text)
PhraseNode	createPhraseNode(ContentNode parent, java.lang.String context, java.lang.String text)
PhraseNode	createPhraseNode(ContentNode parent, java.lang.String context, java.lang.String text, java.util.Map<java.lang.String,java.lang.Object> attributes)
PhraseNode	createPhraseNode(ContentNode parent, java.lang.String context, java.lang.String text, java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.Map<java.lang.String,java.lang.Object> options)
PhraseNode	createPhraseNode(ContentNode parent, java.lang.String context, java.util.List<java.lang.String> text)
PhraseNode	createPhraseNode(ContentNode parent, java.lang.String context, java.util.List<java.lang.String> text, java.util.Map<java.lang.String,java.lang.Object> attributes)
PhraseNode	createPhraseNode(ContentNode parent, java.lang.String context, java.util.List<java.lang.String> text, java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.Map<java.lang.Object,java.lang.Object> options)
Section	createSection(StructuralNode parent)
Section	createSection(StructuralNode parent, boolean numbered, java.util.Map<java.lang.Object,java.lang.Object> options)
Section	createSection(StructuralNode parent, int level, boolean numbered, java.util.Map<java.lang.Object,java.lang.Object> options)
Section	createSection(StructuralNode parent, java.lang.Integer level, boolean numbered, java.util.Map<java.lang.Object,java.lang.Object> options)
Section	createSection(StructuralNode parent, java.util.Map<java.lang.Object,java.lang.Object> options)
Table	createTable(StructuralNode parent)
Table	createTable(StructuralNode parent, java.util.Map<java.lang.String,java.lang.Object> attributes)
Cell	createTableCell(Column column, java.lang.String text)
Cell	createTableCell(Column column, java.lang.String text, java.util.Map<java.lang.String,java.lang.Object> attributes)
Cell	createTableCell(Column column, Document innerDocument)
Cell	createTableCell(Column column, Document innerDocument, java.util.Map<java.lang.String,java.lang.Object> attributes)
Column	createTableColumn(Table parent, int index)
Column	createTableColumn(Table parent, int index, java.util.Map<java.lang.String,java.lang.Object> attributes)
Row	createTableRow(Table parent)
java.util.Map<java.lang.String,java.lang.Object>	getConfig()
void	log(LogRecord logRecord)
Cursor	newCursor(java.lang.String file)
Cursor	newCursor(java.lang.String file, java.lang.String dir)
Cursor	newCursor(java.lang.String file, java.lang.String dir, int lineno)
Reader	newReader(java.util.List<java.lang.String> source)
Reader	newReader(java.util.List<java.lang.String> source, java.util.Map<java.lang.Object,java.lang.Object> options)
Reader	newReader(java.util.List<java.lang.String> source, Cursor cursor)
Reader	newReader(java.util.List<java.lang.String> source, Cursor cursor, java.util.Map<java.lang.Object,java.lang.Object> options)
void	parseContent(StructuralNode parent, java.util.List<java.lang.String> lines)	Parses the given raw asciidoctor content, parses it and appends it as children to the given parent block.
void	setConfig(java.util.Map<java.lang.String,java.lang.Object> config)
<T> T	unwrap(java.lang.Class<T> clazz)
void	updateConfig(java.util.Map<java.lang.String,java.lang.Object> config)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseProcessor

public BaseProcessor()

BaseProcessor

public BaseProcessor(java.util.Map<java.lang.String,java.lang.Object> config)

Method Detail

getConfig

public java.util.Map<java.lang.String,java.lang.Object> getConfig()

Specified by:

getConfig in interface Processor

setConfig

public final void setConfig(java.util.Map<java.lang.String,java.lang.Object> config)

Specified by:

setConfig in interface Processor

updateConfig

public final void updateConfig(java.util.Map<java.lang.String,java.lang.Object> config)

Specified by:

updateConfig in interface Processor

unwrap

public final <T> T unwrap(java.lang.Class<T> clazz)

Specified by:

unwrap in interface Processor

log

public void log(LogRecord logRecord)

Specified by:

log in interface Processor

createTable

public Table createTable(StructuralNode parent)

Specified by:

createTable in interface Processor

createTable

public Table createTable(StructuralNode parent,
                         java.util.Map<java.lang.String,java.lang.Object> attributes)

Specified by:

createTable in interface Processor

createTableRow

public Row createTableRow(Table parent)

Specified by:

createTableRow in interface Processor

createTableColumn

public Column createTableColumn(Table parent,
                                int index,
                                java.util.Map<java.lang.String,java.lang.Object> attributes)

Specified by:

createTableColumn in interface Processor

createTableCell

public Cell createTableCell(Column column,
                            Document innerDocument,
                            java.util.Map<java.lang.String,java.lang.Object> attributes)

Specified by:

createTableCell in interface Processor

createTableCell

public Cell createTableCell(Column column,
                            java.lang.String text,
                            java.util.Map<java.lang.String,java.lang.Object> attributes)

Specified by:

createTableCell in interface Processor

createPhraseNode

public PhraseNode createPhraseNode(ContentNode parent,
                                   java.lang.String context,
                                   java.util.List<java.lang.String> text,
                                   java.util.Map<java.lang.String,java.lang.Object> attributes,
                                   java.util.Map<java.lang.Object,java.lang.Object> options)

Specified by:

createPhraseNode in interface Processor

createPhraseNode

public PhraseNode createPhraseNode(ContentNode parent,
                                   java.lang.String context,
                                   java.lang.String text,
                                   java.util.Map<java.lang.String,java.lang.Object> attributes,
                                   java.util.Map<java.lang.String,java.lang.Object> options)

Specified by:

createPhraseNode in interface Processor

createBlock

public Block createBlock(StructuralNode parent,
                         java.lang.String context,
                         java.util.Map<java.lang.Object,java.lang.Object> options)

Specified by:

createBlock in interface Processor

createSection

public Section createSection(StructuralNode parent,
                             java.lang.Integer level,
                             boolean numbered,
                             java.util.Map<java.lang.Object,java.lang.Object> options)

Specified by:

createSection in interface Processor

createDocument

public Document createDocument(Document parentDocument)

Description copied from interface: Processor

Creates an inner document for the given parent document. Inner documents are used for tables cells with style asciidoc.

Specified by:

createDocument in interface Processor

Parameters:

parentDocument - The parent document of the new document.

Returns:

A new inner document.

createListItem

public ListItem createListItem(List parent,
                               java.lang.String text)

Specified by:

createListItem in interface Processor

createList

public List createList(StructuralNode parent,
                       java.lang.String context)

Description copied from interface: Processor

Creates a new List. This method is experimental and may change in future minor releases until declared to be stable.

Specified by:

createList in interface Processor

Parameters:

parent - The block to which the parsed content should be added as children.

context - Either "olist", ulist, colist or dlist

Returns:

A List node that can be added to the AST of a document.

createList

public List createList(StructuralNode parent,
                       java.lang.String context,
                       java.util.Map<java.lang.String,java.lang.Object> attributes,
                       java.util.Map<java.lang.Object,java.lang.Object> options)

Description copied from interface: Processor

Creates a new List. This method is experimental and may change in future minor releases until declared to be stable.

Specified by:

createList in interface Processor

Parameters:

parent - The block to which the parsed content should be added as children.

context - Either "olist", ulist, colist or dlist

attributes - Additional attributes to be set on the new list node, e.g. Collections.singletonMap("start", "2").

options - Additional options to be set on the new list node.

Returns:

A List node that can be added to the AST of a document.

createList

public List createList(StructuralNode parent,
                       java.lang.String context,
                       java.util.Map<java.lang.Object,java.lang.Object> options)

Description copied from interface: Processor

Creates a new List. This method is experimental and may change in future minor releases until declared to be stable.

Specified by:

createList in interface Processor

Parameters:

parent - The block to which the parsed content should be added as children.

context - Either "olist", ulist, colist or dlist

options - Additional options to be set on the new list node.

Returns:

A List node that can be added to the AST of a document.

createListItem

public ListItem createListItem(DescriptionList parent,
                               java.lang.String text)

Specified by:

createListItem in interface Processor

parseContent

public void parseContent(StructuralNode parent,
                         java.util.List<java.lang.String> lines)

Description copied from interface: Processor

Parses the given raw asciidoctor content, parses it and appends it as children to the given parent block.

The following example will add two paragraphs with the role newcontent to all top level sections of a document:

     
 Asciidoctor asciidoctor = ...
 asciidoctor.javaExtensionRegistry().treeprocessor(new Treeprocessor() {
     DocumentRuby process(DocumentRuby document) {
         for (AbstractBlock block: document.getBlocks()) {
             if (block instanceof Section) {
                 parseContent(block, Arrays.asList(new String[]{
                                             "[newcontent]",
                                             "This is new content"
                                             "",
                                             "[newcontent]",
                                             "This is also new content"}));
             }
         }
     }
 });
     
 

Specified by:

parseContent in interface Processor

Parameters:

parent - The block to which the parsed content should be added as children.

lines - Raw asciidoctor content

newCursor

public Cursor newCursor(java.lang.String file)

Specified by:

newCursor in interface Processor

newCursor

public Cursor newCursor(java.lang.String file,
                        java.lang.String dir)

Specified by:

newCursor in interface Processor

newCursor

public Cursor newCursor(java.lang.String file,
                        java.lang.String dir,
                        int lineno)

Specified by:

newCursor in interface Processor

newReader

public Reader newReader(java.util.List<java.lang.String> source,
                        Cursor cursor,
                        java.util.Map<java.lang.Object,java.lang.Object> options)

Specified by:

newReader in interface Processor

newReader

public Reader newReader(java.util.List<java.lang.String> source,
                        Cursor cursor)

Specified by:

newReader in interface Processor

newReader

public Reader newReader(java.util.List<java.lang.String> source,
                        java.util.Map<java.lang.Object,java.lang.Object> options)

Specified by:

newReader in interface Processor

newReader

public Reader newReader(java.util.List<java.lang.String> source)

Specified by:

newReader in interface Processor

createTableColumn

public Column createTableColumn(Table parent,
                                int index)

Specified by:

createTableColumn in interface Processor

createTableCell

public Cell createTableCell(Column column,
                            java.lang.String text)

Specified by:

createTableCell in interface Processor

createTableCell

public Cell createTableCell(Column column,
                            Document innerDocument)

Specified by:

createTableCell in interface Processor

createBlock

public Block createBlock(StructuralNode parent,
                         java.lang.String context,
                         java.lang.String content)

Specified by:

createBlock in interface Processor

createBlock

public Block createBlock(StructuralNode parent,
                         java.lang.String context,
                         java.lang.String content,
                         java.util.Map<java.lang.String,java.lang.Object> attributes)

Specified by:

createBlock in interface Processor

createBlock

public Block createBlock(StructuralNode parent,
                         java.lang.String context,
                         java.lang.String content,
                         java.util.Map<java.lang.String,java.lang.Object> attributes,
                         java.util.Map<java.lang.Object,java.lang.Object> options)

Specified by:

createBlock in interface Processor

createBlock

public Block createBlock(StructuralNode parent,
                         java.lang.String context,
                         java.util.List<java.lang.String> content)

Specified by:

createBlock in interface Processor

createBlock

public Block createBlock(StructuralNode parent,
                         java.lang.String context,
                         java.util.List<java.lang.String> content,
                         java.util.Map<java.lang.String,java.lang.Object> attributes)

Specified by:

createBlock in interface Processor

createBlock

public Block createBlock(StructuralNode parent,
                         java.lang.String context,
                         java.util.List<java.lang.String> content,
                         java.util.Map<java.lang.String,java.lang.Object> attributes,
                         java.util.Map<java.lang.Object,java.lang.Object> options)

Specified by:

createBlock in interface Processor

createSection

public Section createSection(StructuralNode parent)

Specified by:

createSection in interface Processor

createSection

public Section createSection(StructuralNode parent,
                             java.util.Map<java.lang.Object,java.lang.Object> options)

Specified by:

createSection in interface Processor

createSection

public Section createSection(StructuralNode parent,
                             boolean numbered,
                             java.util.Map<java.lang.Object,java.lang.Object> options)

Specified by:

createSection in interface Processor

createSection

public Section createSection(StructuralNode parent,
                             int level,
                             boolean numbered,
                             java.util.Map<java.lang.Object,java.lang.Object> options)

Specified by:

createSection in interface Processor

createPhraseNode

public PhraseNode createPhraseNode(ContentNode parent,
                                   java.lang.String context,
                                   java.util.List<java.lang.String> text)

Specified by:

createPhraseNode in interface Processor

createPhraseNode

public PhraseNode createPhraseNode(ContentNode parent,
                                   java.lang.String context,
                                   java.util.List<java.lang.String> text,
                                   java.util.Map<java.lang.String,java.lang.Object> attributes)

Specified by:

createPhraseNode in interface Processor

createPhraseNode

public PhraseNode createPhraseNode(ContentNode parent,
                                   java.lang.String context,
                                   java.lang.String text)

Specified by:

createPhraseNode in interface Processor

createPhraseNode

public PhraseNode createPhraseNode(ContentNode parent,
                                   java.lang.String context,
                                   java.lang.String text,
                                   java.util.Map<java.lang.String,java.lang.Object> attributes)

Specified by:

createPhraseNode in interface Processor