Package org.apache.maven.doxia.macro
Interface Macro
-
- All Superinterfaces:
LogEnabled
- All Known Implementing Classes:
AbstractMacro
,EchoMacro
,SnippetMacro
,SsiMacro
,SwfMacro
,TocMacro
public interface Macro extends LogEnabled
Base interface of a macro.- Since:
- 1.0
- Version:
- $Id$
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
execute(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
-
-
-
-
Method Detail
-
execute
void execute(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.
-
-