org.radeox.macro
Class FilePathMacro
java.lang.Object
org.radeox.macro.BaseMacro
org.radeox.macro.Preserved
org.radeox.macro.LocalePreserved
org.radeox.macro.FilePathMacro
- All Implemented Interfaces:
- java.lang.Comparable, LocaleMacro, Macro
- public class FilePathMacro
- extends LocalePreserved
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
FilePathMacro
public FilePathMacro()
getLocaleKey
public java.lang.String getLocaleKey()
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
- Throws:
java.lang.IllegalArgumentException
java.io.IOException
Copyright © 2003 Matthias L. Jugel, Stephan J. Schmidt. All Rights Reserved.