org.apache.maven.doxia.macro
Interface Macro

All Known Implementing Classes:

AbstractMacro

public interface Macro

Base interface of a macro.

Since:

1.0

Version:

$Id: Macro.java 567311 2007-08-18 18:30:54Z vsiveton $

Author:

Jason van Zyl

Field Summary

static String

ROLE The Plexus lookup role.

Method Summary

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.

Field Detail

ROLE

public static final String ROLE

The Plexus lookup role.

Method Detail

execute

public 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.