Package org.apache.maven.doxia.macro

Interface MacroExecutor

All Known Implementing Classes:

AbstractParser, AbstractTextParser, AbstractXmlParser, AptParser, FmlContentParser, FmlParser, MarkdownParser, MarkdownParser.MarkdownHtmlParser, XdocParser, Xhtml1BaseParser, Xhtml5BaseParser, Xhtml5Parser

public interface MacroExecutor

Interface implemented by all parsers that support macros and which can be used to overwrite macro execution via Parser.setMacroExecutor(MacroExecutor).

Method Summary

Modifier and Type	Method	Description
void	executeMacro(String macroId, MacroRequest request, Sink sink)	Execute a macro on the given sink.

Method Details

executeMacro

void executeMacro(String macroId,
 MacroRequest request,
 Sink sink)
           throws MacroExecutionException,
MacroNotFoundException

Execute a macro on the given sink.

Parameters:

macroId - an id to lookup the macro

request - the corresponding MacroRequest

sink - the sink to receive the events

Throws:

MacroExecutionException - if an error occurred during execution

MacroNotFoundException - if the macro could not be found