Package org.apache.maven.doxia.macro
Interface MacroExecutor
-
- All Known Implementing Classes:
AbstractParser,AbstractTextParser,AbstractXmlParser,Xhtml1BaseParser,Xhtml5BaseParser
public interface MacroExecutorInterface implemented by all parsers that support macros and which can be used to overwrite macro execution viaParser.setMacroExecutor(MacroExecutor).
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidexecuteMacro(java.lang.String macroId, MacroRequest request, org.apache.maven.doxia.sink.Sink sink)Execute a macro on the given sink.
-
-
-
Method Detail
-
executeMacro
void executeMacro(java.lang.String macroId, MacroRequest request, org.apache.maven.doxia.sink.Sink sink) throws MacroExecutionException, MacroNotFoundExceptionExecute a macro on the given sink.- Parameters:
macroId- an id to lookup the macrorequest- the corresponding MacroRequestsink- the sink to receive the events- Throws:
MacroExecutionException- if an error occurred during executionMacroNotFoundException- if the macro could not be found
-
-