EchoMacro (Doxia :: Core 1.4 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.doxia.macro
Class EchoMacro

java.lang.Object
  org.apache.maven.doxia.macro.AbstractMacro
      org.apache.maven.doxia.macro.EchoMacro

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

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

Field Summary

Fields inherited from interface org.apache.maven.doxia.macro.Macro
`EOL, ROLE`

Constructor Summary
`EchoMacro()`

Method Summary
`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

public EchoMacro()

Method Detail

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.