org.radeox.macro
Class CodeMacro

java.lang.Object
  extended by org.radeox.macro.BaseMacro
      extended by org.radeox.macro.Preserved
          extended by org.radeox.macro.LocalePreserved
              extended by org.radeox.macro.CodeMacro
All Implemented Interfaces:
java.lang.Comparable, LocaleMacro, Macro

public class CodeMacro
extends LocalePreserved


Field Summary
 
Fields inherited from class org.radeox.macro.BaseMacro
description, initialContext, paramDescription
 
Constructor Summary
CodeMacro()
           
 
Method Summary
 void execute(java.io.Writer writer, MacroParameter params)
          Execute the macro.
 java.lang.String getLocaleKey()
           
 void setInitialContext(InitialRenderContext context)
           
 
Methods inherited from class org.radeox.macro.LocalePreserved
getDescription, getName, getParamDescription
 
Methods inherited from class org.radeox.macro.Preserved
addSpecial, addSpecial, replace
 
Methods inherited from class org.radeox.macro.BaseMacro
compareTo, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CodeMacro

public CodeMacro()
Method Detail

getLocaleKey

public java.lang.String getLocaleKey()

setInitialContext

public void setInitialContext(InitialRenderContext context)
Specified by:
setInitialContext in interface Macro
Overrides:
setInitialContext in class LocalePreserved

execute

public void execute(java.io.Writer writer,
                    MacroParameter params)
             throws java.lang.IllegalArgumentException,
                    java.io.IOException
Description copied from class: BaseMacro
Execute the macro. This method is called by MacroFilter to handle macros.

Specified by:
execute in interface Macro
Specified by:
execute in class BaseMacro
Parameters:
writer - A write where the macro should write its output to
params - Macro parameters with the parameters the macro is called with
Throws:
java.lang.IllegalArgumentException
java.io.IOException