Package org.radeox.macro

Class MacroListMacro

java.lang.Object

org.radeox.macro.BaseMacro

org.radeox.macro.BaseLocaleMacro

org.radeox.macro.MacroListMacro

All Implemented Interfaces:

Comparable, org.radeox.api.macro.Macro, LocaleMacro

public class MacroListMacro
extends BaseLocaleMacro

Field Summary

Fields inherited from class org.radeox.macro.BaseMacro

description, initialContext, paramDescription

Constructor Summary

Constructors

Constructor	Description
MacroListMacro()

Method Summary

Modifier and Type	Method	Description
Writer	appendTo(Writer writer)
void	execute(Writer writer, org.radeox.api.macro.MacroParameter params)	Execute the macro.
String	getLocaleKey()

Methods inherited from class org.radeox.macro.BaseLocaleMacro

getName, setInitialContext

Methods inherited from class org.radeox.macro.BaseMacro

compareTo, getDescription, getParamDescription, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroListMacro

public MacroListMacro()

Method Detail

getLocaleKey

public String getLocaleKey()

execute

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

Description copied from class: BaseMacro

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

Specified by:

execute in interface org.radeox.api.macro.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:

IllegalArgumentException

IOException

appendTo

public Writer appendTo(Writer writer)
                throws IOException

Throws:

IOException