org.asciidoctor.extension.ExtensionGroup Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of asciidoctorj-api Show documentation
API for AsciidoctorJ
There is a newer version: 3.0.0
package org.asciidoctor.extension;


import java.io.InputStream;

/**
 * An ExtensionGroup allows to collectively register and unregister extensions.
 * All extensions are registered lazily and are not effective before a call to {@link #register()}.
 *
 * Example:
 * 
 * ExtensionGroup group = asciidoctor.createGroup();
 * group.block(myBlock).preprocessor(mypreprocessor);
 *
 * // Convert with extensions
 * group.register();
 * asciidoctor.convert(...);
 * group.unregister();
 *
 * // Convert without extensions
 * asciidoctor.convert(...);
 * 

 */
public interface ExtensionGroup {

  void register();

  void unregister();

  ExtensionGroup docinfoProcessor(Class docInfoProcessor);
  ExtensionGroup docinfoProcessor(DocinfoProcessor docInfoProcessor);
  ExtensionGroup docinfoProcessor(String docInfoProcessor);

  ExtensionGroup preprocessor(Class preprocessor);
  ExtensionGroup preprocessor(Preprocessor preprocessor);
  ExtensionGroup preprocessor(String preprocessor);

  ExtensionGroup postprocessor(String postprocessor);
  ExtensionGroup postprocessor(Class postprocessor);
  ExtensionGroup postprocessor(Postprocessor postprocesor);

  ExtensionGroup includeProcessor(String includeProcessor);
  ExtensionGroup includeProcessor(Class includeProcessor);
  ExtensionGroup includeProcessor(IncludeProcessor includeProcessor);

  ExtensionGroup treeprocessor(Treeprocessor treeprocessor);
  ExtensionGroup treeprocessor(Class treeProcessor);
  ExtensionGroup treeprocessor(String treeProcessor);

  ExtensionGroup block(String blockName, String blockProcessor);
  ExtensionGroup block(String blockProcessor);
  ExtensionGroup block(String blockName, Class blockProcessor);
  ExtensionGroup block(Class blockProcessor);
  ExtensionGroup block(String blockName, BlockProcessor blockProcessor);
  ExtensionGroup block(BlockProcessor blockProcessor);

  ExtensionGroup blockMacro(String blockName, Class blockMacroProcessor);
  ExtensionGroup blockMacro(Class blockMacroProcessor);
  ExtensionGroup blockMacro(String blockName, String blockMacroProcessor);
  ExtensionGroup blockMacro(String blockMacroProcessor);
  ExtensionGroup blockMacro(BlockMacroProcessor blockMacroProcessor);

  ExtensionGroup inlineMacro(InlineMacroProcessor inlineMacroProcessor);
  ExtensionGroup inlineMacro(String name, Class inlineMacroProcessor);
  ExtensionGroup inlineMacro(Class inlineMacroProcessor);
  ExtensionGroup inlineMacro(String name, String inlineMacroProcessor);
  ExtensionGroup inlineMacro(String inlineMacroProcessor);

  ExtensionGroup requireRubyLibrary(String requiredLibrary);
  ExtensionGroup loadRubyClass(InputStream rubyClassStream);

  ExtensionGroup rubyPreprocessor(String preprocessor);
  ExtensionGroup rubyPostprocessor(String postprocessor);
  ExtensionGroup rubyDocinfoProcessor(String docinfoProcessor);
  ExtensionGroup rubyIncludeProcessor(String includeProcessor);
  ExtensionGroup rubyTreeprocessor(String treeProcessor);

  ExtensionGroup rubyBlock(String blockName, String blockProcessor);
  ExtensionGroup rubyBlock(String blockProcessor);

  ExtensionGroup rubyBlockMacro(String blockName, String blockMacroProcessor);
  ExtensionGroup rubyBlockMacro(String blockMacroProcessor);

  ExtensionGroup rubyInlineMacro(String macroName, String inlineMacroProcessor);
  ExtensionGroup rubyInlineMacro(String inlineMacroProcessor);
}