org.apache.maven.doxia.macro
Class SwfMacro

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

All Implemented Interfaces:

LogEnabled, Macro

public class SwfMacro
extends AbstractMacro

Macro for embedding Flash (SWF) within Maven documentation.

Version:

$Id: SwfMacro.java 1151002 2011-07-26 07:17:54Z ltheussl $

Author:

Steve Motola, Vincent Siveton

Plexus component:

role:

"org.apache.maven.doxia.macro.Macro"

role-hint:

"swf"

Field Summary

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

EOL, ROLE

Constructor Summary

SwfMacro()

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

SwfMacro

public SwfMacro()

Method Detail

execute

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