uk.ac.cam.caret.sakai.rwiki.component.macros

Class CommentMacro

java.lang.Object

org.radeox.macro.BaseMacro

uk.ac.cam.caret.sakai.rwiki.component.macros.CommentMacro

All Implemented Interfaces:

Comparable, Macro

public class CommentMacro
extends BaseMacro

Author:

denny.denny at gmail.com

Field Summary

Fields inherited from class org.radeox.macro.BaseMacro

description, initialContext, paramDescription

Constructor Summary

Constructors

Constructor and Description
CommentMacro()

Method Summary

Modifier and Type	Method and Description
void	execute(Writer writer, MacroParameter params)
String	getDescription()
String	getName()
String[]	getParamDescription()

Methods inherited from class org.radeox.macro.BaseMacro

compareTo, setInitialContext, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentMacro

public CommentMacro()

Method Detail

getDescription

public String getDescription()

Specified by:

getDescription in interface Macro

Overrides:

getDescription in class BaseMacro

getParamDescription

public String[] getParamDescription()

Specified by:

getParamDescription in interface Macro

Overrides:

getParamDescription in class BaseMacro

execute

public void execute(Writer writer,
                    MacroParameter params)
             throws IllegalArgumentException,
                    IOException

Specified by:

execute in interface Macro

Specified by:

execute in class BaseMacro

Throws:

IllegalArgumentException

IOException

getName

public String getName()

Specified by:

getName in interface Macro

Specified by:

getName in class BaseMacro