org.radeox.macro
Class LocalePreserved

java.lang.Object
  extended by org.radeox.macro.BaseMacro
      extended by org.radeox.macro.Preserved
          extended by org.radeox.macro.LocalePreserved
All Implemented Interfaces:
java.lang.Comparable, LocaleMacro, Macro
Direct Known Subclasses:
CodeMacro, FilePathMacro, MailToMacro, QuoteMacro

public abstract class LocalePreserved
extends Preserved
implements LocaleMacro


Field Summary
 
Fields inherited from class org.radeox.macro.BaseMacro
description, initialContext, paramDescription
 
Constructor Summary
LocalePreserved()
           
 
Method Summary
 java.lang.String getDescription()
          Get a description of the macro.
 java.lang.String getName()
          Get the name of the macro.
 java.lang.String[] getParamDescription()
          Get a description of the paramters of the macro.
 void setInitialContext(InitialRenderContext context)
           
 
Methods inherited from class org.radeox.macro.Preserved
addSpecial, addSpecial, replace
 
Methods inherited from class org.radeox.macro.BaseMacro
compareTo, execute, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.radeox.macro.LocaleMacro
getLocaleKey
 

Constructor Detail

LocalePreserved

public LocalePreserved()
Method Detail

getName

public java.lang.String getName()
Description copied from class: BaseMacro
Get the name of the macro. This is used to map a macro in the input to the macro which should be called. The method has to be implemented by subclassing classes.

Specified by:
getName in interface Macro
Specified by:
getName in class BaseMacro
Returns:
name Name of the Macro

getDescription

public java.lang.String getDescription()
Description copied from class: BaseMacro
Get a description of the macro. This description explains in a short way what the macro does

Specified by:
getDescription in interface Macro
Overrides:
getDescription in class BaseMacro
Returns:
description A string describing the macro

getParamDescription

public java.lang.String[] getParamDescription()
Description copied from class: BaseMacro
Get a description of the paramters of the macro. The method returns an array with an String entry for every parameter. The format is {"1: description", ...} where 1 is the position of the parameter.

Specified by:
getParamDescription in interface Macro
Overrides:
getParamDescription in class BaseMacro
Returns:
description Array describing the parameters of the macro

setInitialContext

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