org.trypticon.snipsnap.macro
Class JepMacro

java.lang.Object
  extended by org.radeox.macro.BaseMacro
      extended by org.trypticon.snipsnap.macro.JepMacro
All Implemented Interfaces:
java.lang.Comparable, org.radeox.macro.Macro

public class JepMacro
extends org.radeox.macro.BaseMacro

Macro which will display a link to jabber.org JEP data.


Field Summary
 
Fields inherited from class org.radeox.macro.BaseMacro
description, initialContext, paramDescription
 
Constructor Summary
JepMacro()
           
 
Method Summary
 void execute(java.io.Writer writer, org.radeox.macro.parameter.MacroParameter params)
          Executes the macro.
 java.lang.String getDescription()
          Gets the description of the macro.
 java.lang.String getName()
          Gets the name of the macro, which becomes the macro's prefix.
 java.lang.String[] getParamDescription()
          Gets the description of the macro's parameters.
 
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

JepMacro

public JepMacro()
Method Detail

execute

public void execute(java.io.Writer writer,
                    org.radeox.macro.parameter.MacroParameter params)
             throws java.io.IOException
Executes the macro.

Specified by:
execute in interface org.radeox.macro.Macro
Specified by:
execute in class org.radeox.macro.BaseMacro
Parameters:
writer - the writer to append to.
params - the parameters passed to the macro.
Throws:
java.io.IOException - if there was an error appending to the writer.

getName

public java.lang.String getName()
Gets the name of the macro, which becomes the macro's prefix.

Specified by:
getName in interface org.radeox.macro.Macro
Specified by:
getName in class org.radeox.macro.BaseMacro
Returns:
the name of the macro.

getDescription

public java.lang.String getDescription()
Gets the description of the macro.

Specified by:
getDescription in interface org.radeox.macro.Macro
Overrides:
getDescription in class org.radeox.macro.BaseMacro
Returns:
the description of the macro.

getParamDescription

public java.lang.String[] getParamDescription()
Gets the description of the macro's parameters.

Specified by:
getParamDescription in interface org.radeox.macro.Macro
Overrides:
getParamDescription in class org.radeox.macro.BaseMacro
Returns:
the description of the macro's parameters, each parameters in an element of the array.