org.radeox.macro
Interface Macro

All Superinterfaces:

java.lang.Comparable

All Known Implementing Classes:

BaseMacro

public interface Macro

extends java.lang.Comparable

Method Summary

void	execute(java.io.Writer writer, MacroParameter params) Execute the macro.
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 interface java.lang.Comparable

compareTo

Method Detail

getName

public java.lang.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.

Returns:

name Name of the Macro

getDescription

public java.lang.String getDescription()

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

Returns:

description A string describing the macro

getParamDescription

public java.lang.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.

Returns:

description Array describing the parameters of the macro

setInitialContext

public void setInitialContext(InitialRenderContext context)

execute

public void execute(java.io.Writer writer,
                    MacroParameter params)
             throws java.lang.IllegalArgumentException,
                    java.io.IOException

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

Parameters:

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

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

java.lang.IllegalArgumentException

java.io.IOException