org.asciidoctor.extension

Annotation Type Contexts

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Contexts

This annotation defines what type of blocks a BlockProcessor processes. Example for a BlockProcessor that transforms all open blocks with the name yell to upper case:

 @Name("yell")
 @Contexts(Contexts.CONTEXT_OPEN)
 @ContentModel(ContentModel.SIMPLE)
 class YellBlockProcessor extends BlockProcessor {
     public YellBlockProcessor(String blockName) {
         super(blockName);
     }

     public Object process(StructuralNode parent, Reader reader, Map attributes) {
         List lines = reader.readLines();
         List newLines = new ArrayList<>();
         for (String line: lines) {
             newLines.add(line.toUpperCase());
         }
         return createBlock(parent, 'paragraph', newLines)
     }
 }
 
 

Applicable for:

BlockMacroProcessor
BlockProcessor	✓
BlockProcessor
DocInfoProcessor
IncludeProcessor
InlineMacroProcessor
Postprocessor
Preprocessor
Treeprocessor

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	CONTEXT_EXAMPLE Predefined constant for making a Processor work on example blocks.
static java.lang.String	CONTEXT_LISTING Predefined constant for making a Processor work on source blocks.
static java.lang.String	CONTEXT_LITERAL Predefined constant for making a Processor work on literal blocks.
static java.lang.String	CONTEXT_OPEN Predefined constant for making a Processor work on open blocks.
static java.lang.String	CONTEXT_PARAGRAPH Predefined constant for making a Processor work on paragraph blocks.
static java.lang.String	CONTEXT_PASS Predefined constant for making a Processor work on passthrough blocks.
static java.lang.String	CONTEXT_QUOTE Predefined constant for making a Processor work on quote blocks.
static java.lang.String	CONTEXT_SIDEBAR Predefined constant for making a Processor work on sidebar blocks.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String[]	value

Field Detail

CONTEXT_OPEN

public static final java.lang.String CONTEXT_OPEN

Predefined constant for making a Processor work on open blocks.

 [foo]
 --
 An open block can be an anonymous container,
 or it can masquerade as any other block.
 --
 

CONTEXT_EXAMPLE

public static final java.lang.String CONTEXT_EXAMPLE

Predefined constant for making a Processor work on example blocks.

 [foo]
 ====
 This is just a neat example.
 ====
 

CONTEXT_SIDEBAR

public static final java.lang.String CONTEXT_SIDEBAR

Predefined constant for making a Processor work on sidebar blocks.

 [foo]
 ****
 This is just a sidebar.
 ****
 

CONTEXT_LITERAL

public static final java.lang.String CONTEXT_LITERAL

Predefined constant for making a Processor work on literal blocks.

 [foo]
 ....
 This is just a literal block.
 ....
 

CONTEXT_LISTING

public static final java.lang.String CONTEXT_LISTING

Predefined constant for making a Processor work on source blocks.

 [foo]
 ....
 This is just a literal block.
 ....
 

CONTEXT_QUOTE

public static final java.lang.String CONTEXT_QUOTE

Predefined constant for making a Processor work on quote blocks.

 [foo]
 ____
 To be or not to be...
 ____
 

CONTEXT_PASS

public static final java.lang.String CONTEXT_PASS

Predefined constant for making a Processor work on passthrough blocks.

 [foo]
 ++++
 <h1>Big text</h1>
 ++++
 

CONTEXT_PARAGRAPH

public static final java.lang.String CONTEXT_PARAGRAPH

Predefined constant for making a Processor work on paragraph blocks.

 [foo]
 Please process this paragraph.

 And don't process this.
 

Element Detail

value

public abstract java.lang.String[] value