Package org.radeox.macro

Class BaseMacro

java.lang.Object

org.radeox.macro.BaseMacro

All Implemented Interfaces:

Comparable, org.radeox.api.macro.Macro

Direct Known Subclasses:

BaseLocaleMacro, HelloWorldMacro, Preserved

public abstract class BaseMacro
extends Object
implements org.radeox.api.macro.Macro

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description
protected org.radeox.api.engine.context.InitialRenderContext	initialContext
protected String[]	paramDescription

Constructor Summary

Constructors

Constructor	Description
BaseMacro()

Method Summary

Modifier and Type	Method	Description
int	compareTo(Object object)
abstract void	execute(Writer writer, org.radeox.api.macro.MacroParameter params)	Execute the macro.
String	getDescription()	Get a description of the macro.
abstract String	getName()	Get the name of the macro.
String[]	getParamDescription()	Get a description of the paramters of the macro.
void	setInitialContext(org.radeox.api.engine.context.InitialRenderContext context)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

initialContext

protected org.radeox.api.engine.context.InitialRenderContext initialContext

description

protected String description

paramDescription

protected String[] paramDescription

Constructor Detail

BaseMacro

public BaseMacro()

Method Detail

getName

public abstract String getName()

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 org.radeox.api.macro.Macro

Returns:

name Name of the Macro

getDescription

public String getDescription()

Get a description of the macro. This description explains in a short way what the macro does

Specified by:

getDescription in interface org.radeox.api.macro.Macro

Returns:

description A string describing the macro

getParamDescription

public String[] getParamDescription()

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 org.radeox.api.macro.Macro

Returns:

description Array describing the parameters of the macro

setInitialContext

public void setInitialContext(org.radeox.api.engine.context.InitialRenderContext context)

Specified by:

setInitialContext in interface org.radeox.api.macro.Macro

execute

public abstract void execute(Writer writer,
                             org.radeox.api.macro.MacroParameter params)
                      throws IllegalArgumentException,
                             IOException

Execute the macro. This method is called by MacroFilter to handle macros.

Specified by:

execute in interface org.radeox.api.macro.Macro

Parameters:

writer - A write where the macro should write its output to

params - Macro parameters with the parameters the macro is called with

Throws:

IllegalArgumentException

IOException

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Object object)

Specified by:

compareTo in interface Comparable