public abstract class BlockProcessor extends Processor
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CONTEXT_EXAMPLE
Predefined constant for making a BlockProcessor work on example blocks.
|
static java.lang.String |
CONTEXT_LISTING
Predefined constant for making a BlockProcessor work on source blocks.
|
static java.lang.String |
CONTEXT_LITERAL
Predefined constant for making a BlockProcessor work on literal blocks.
|
static java.lang.String |
CONTEXT_OPEN
Predefined constant for making a BlockProcessor work on open blocks.
|
static java.lang.String |
CONTEXT_PARAGRAPH
Predefined constant for making a BlockProcessor work on paragraph blocks.
|
static java.lang.String |
CONTEXT_PASS
Predefined constant for making a BlockProcessor work on passthrough blocks.
|
static java.lang.String |
CONTEXT_QUOTE
Predefined constant for making a BlockProcessor work on quote blocks.
|
static java.lang.String |
CONTEXT_SIDEBAR
Predefined constant for making a BlockProcessor work on sidebar blocks.
|
static java.lang.String |
CONTEXTS
This value is used as the config option key when defining the block type
a Processor should process.
|
protected java.lang.String |
name |
config, CONTENT_MODEL, CONTENT_MODEL_ATTRIBUTES, CONTENT_MODEL_COMPOUND, CONTENT_MODEL_EMPTY, CONTENT_MODEL_RAW, CONTENT_MODEL_SIMPLE, CONTENT_MODEL_SKIP, CONTENT_MODEL_VERBATIM
Constructor and Description |
---|
BlockProcessor() |
BlockProcessor(java.lang.String name) |
BlockProcessor(java.lang.String name,
java.util.Map<java.lang.String,java.lang.Object> config) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getName() |
abstract java.lang.Object |
process(StructuralNode parent,
Reader reader,
java.util.Map<java.lang.String,java.lang.Object> attributes) |
void |
setName(java.lang.String name) |
createBlock, createBlock, createBlock, createBlock, createBlock, createBlock, createDocument, createListItem, createListItem, createPhraseNode, createPhraseNode, createPhraseNode, createPhraseNode, createPhraseNode, createPhraseNode, createSection, createSection, createSection, createSection, createTable, createTable, createTableCell, createTableCell, createTableCell, createTableCell, createTableColumn, createTableColumn, createTableRow, getConfig, parseContent, setConfig, setConfigFinalized, updateConfig
public static final java.lang.String CONTEXTS
Example to make a BlockProcessor work on listings and examples named foo:
Map<String, Object> config = new HashMap<>(); config.put(CONTEXTS, Arrays.asList(EXAMPLE, LISTING)); BlockProcessor blockProcessor = new BlockProcessor("foo", config); asciidoctor.javaExtensionRegistry().block(blockProcessor);
public static final java.lang.String CONTEXT_OPEN
CONTEXTS
config option this BlockProcessor works on open blocks:
[foo] -- An open block can be an anonymous container, or it can masquerade as any other block. --
public static final java.lang.String CONTEXT_EXAMPLE
CONTEXTS
config option this BlockProcessor works on example blocks:
[foo] ==== This is just a neat example. ====
public static final java.lang.String CONTEXT_SIDEBAR
CONTEXTS
config option this BlockProcessor works on sidebar blocks:
[foo] **** This is just a sidebar. ****
public static final java.lang.String CONTEXT_LITERAL
CONTEXTS
config option this BlockProcessor works on literal blocks:
[foo] .... This is just a literal block. ....
public static final java.lang.String CONTEXT_LISTING
CONTEXTS
config option this BlockProcessor works on source blocks:
[foo] .... This is just a literal block. ....
public static final java.lang.String CONTEXT_QUOTE
CONTEXTS
config option this BlockProcessor works on quote blocks:
[foo] ____ To be or not to be... ____
public static final java.lang.String CONTEXT_PASS
CONTEXTS
config option this BlockProcessor works on passthrough blocks:
[foo] ++++ <h1>Big text</h1> ++++
public static final java.lang.String CONTEXT_PARAGRAPH
CONTEXTS
config option if no other context is given.
When passed with the CONTEXTS
config option this BlockProcessor works on paragraph blocks:
[foo] Please process this paragraph. And don't process this.
protected java.lang.String name
public BlockProcessor()
public BlockProcessor(java.lang.String name)
public BlockProcessor(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> config)
public java.lang.String getName()
public void setName(java.lang.String name)
public abstract java.lang.Object process(StructuralNode parent, Reader reader, java.util.Map<java.lang.String,java.lang.Object> attributes)