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

Version:

$Id: Macro.java 746978 2009-02-23 12:20:33Z vsiveton $

Author:

Jason van Zyl

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	EOL	The vm line separator
static java.lang.String	ROLE	The Plexus lookup role.

Method Summary

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.

Methods inherited from interface org.apache.maven.doxia.logging.LogEnabled

enableLogging

Field Detail

ROLE

static final java.lang.String ROLE

The Plexus lookup role.

EOL

static final java.lang.String EOL

The vm line separator

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.