Package org.apache.maven.doxia.macro
Interface Macro
- All Superinterfaces:
org.apache.maven.doxia.logging.LogEnabled
- All Known Implementing Classes:
AbstractMacro
,EchoMacro
,SnippetMacro
,SsiMacro
,SwfMacro
,TocMacro
public interface Macro
extends org.apache.maven.doxia.logging.LogEnabled
Base interface of a macro.
- Since:
- 1.0
- Author:
- Jason van Zyl
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.Methods inherited from interface org.apache.maven.doxia.logging.LogEnabled
enableLogging
-
Field Details
-
ROLE
The Plexus lookup role. -
EOL
The vm line separator
-
-
Method Details
-
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.
-