Package org.apache.maven.doxia.macro
Interface Macro
-
- All Known Implementing Classes:
AbstractMacro
,EchoMacro
,SnippetMacro
,TocMacro
public interface Macro
Base interface of a macro.- Since:
- 1.0
- Author:
- Jason van Zyl
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
EOL
The vm line separator
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
execute(org.apache.maven.doxia.sink.Sink sink, MacroRequest request)
Execute the current macro using the given MacroRequest, and emit events into the given sink.
-
-
-
Method Detail
-
execute
void execute(org.apache.maven.doxia.sink.Sink sink, MacroRequest request) throws MacroExecutionException
Execute the current macro using the given MacroRequest, and emit events into the given sink.- Parameters:
sink
- The sink to receive the events.request
- The corresponding MacroRequest.- Throws:
MacroExecutionException
- if an error occurred during execution.
-
-