org.apache.maven.doxia.macro

Class EchoMacro

java.lang.Object

org.apache.maven.doxia.macro.AbstractMacro

org.apache.maven.doxia.macro.EchoMacro

All Implemented Interfaces:

LogEnabled, Macro

@Component(role=Macro.class,
           hint="echo")
public class EchoMacro
extends AbstractMacro

A simple macro that prints out the key and value of some supplied parameters.

Version:

$Id: EchoMacro.java 1345590 2012-06-02 21:36:10Z hboutemy $

Field Summary

Fields inherited from interface org.apache.maven.doxia.macro.Macro

EOL, ROLE

Constructor Summary

Constructors

Constructor and Description
EchoMacro()

Method Summary

Methods

Modifier and Type	Method and 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 class org.apache.maven.doxia.macro.AbstractMacro

enableLogging, getAttributesFromMap, getLog, required

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EchoMacro

public EchoMacro()

Method Detail

execute

public void execute(Sink sink,
           MacroRequest request)

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.