org.radeox.macro
Class HelloWorldMacro
java.lang.Object
|
+--org.radeox.macro.BaseMacro
|
+--org.radeox.macro.HelloWorldMacro
- All Implemented Interfaces:
- java.lang.Comparable, Macro
- public class HelloWorldMacro
- extends BaseMacro
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
HelloWorldMacro
public HelloWorldMacro()
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
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 toparams
- Macro parameters with the parameters the macro is called with
java.lang.IllegalArgumentException
java.io.IOException
Copyright © 2003 Matthias L. Jugel, Stephan J. Schmidt. All Rights Reserved.