pmp
Class DefinedMacro

java.lang.Object
  extended by pmp.AbstractMacro
      extended by pmp.DefinedMacro

public final class DefinedMacro
extends AbstractMacro

User-defined macro. It is used for configuration directives and other data stored in macroprocessor's MacroList.

Notes: All descendants of AbstractMacro class (including this class) are considered to be immutable. If you want to redefine macro, create new object and change reference in MacroList using MacroList.setMacro(String, AbstractMacro) or similar method.

Title: PMP: Macroprocessor

Description: Java macroprocessor

Copyright: Copyright (c) 2005

Version:
1.0
Author:
Luděk Hlaváček

Field Summary
protected  java.lang.String expansion
          expansion string
 
Fields inherited from class pmp.AbstractMacro
PARAMS_REQUIRED
 
Constructor Summary
DefinedMacro(java.lang.String expansion)
           
 
Method Summary
 java.lang.String run(Macroprocessor mp, java.lang.String[] args)
          Expands given macro with given arguments.
 java.lang.String toString()
          Returns expansion string.
 
Methods inherited from class pmp.AbstractMacro
getRequiredParams
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

expansion

protected final java.lang.String expansion
expansion string

Constructor Detail

DefinedMacro

public DefinedMacro(java.lang.String expansion)
Method Detail

run

public java.lang.String run(Macroprocessor mp,
                            java.lang.String[] args)
Expands given macro with given arguments.

Specified by:
run in class AbstractMacro
Parameters:
mp - reference to Macroprocessor
args - parameters of macro. In args[0] is stored name of macro. Subclasses are free to modify this array.
Returns:
result of the macro as String

toString

public java.lang.String toString()
Returns expansion string.

Overrides:
toString in class AbstractMacro
Returns:
expansion string
See Also:
Defn