pmp.macro
Class Builtin

java.lang.Object
  extended by pmp.AbstractMacro
      extended by pmp.macro.Builtin

public class Builtin
extends AbstractMacro

Loads Java-class macro.

The first parameter specifies name to be assigned to this macro; the second parameter constains name of class.

Third parametre may contain name of Java class macro, which will be used as output encoder for defined macro.

Title: PMP: Macroprocessor

Description: Java macroprocessor

Copyright: Copyright (c) 2005

Company:

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

Field Summary
static int PARAMS_REQUIRED
           
 
Constructor Summary
Builtin()
           
 
Method Summary
 java.lang.String run(Macroprocessor mp, java.lang.String[] params)
          Main method of macro.
 
Methods inherited from class pmp.AbstractMacro
getRequiredParams, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PARAMS_REQUIRED

public static final int PARAMS_REQUIRED
See Also:
Constant Field Values
Constructor Detail

Builtin

public Builtin()
Method Detail

run

public java.lang.String run(Macroprocessor mp,
                            java.lang.String[] params)
Description copied from class: AbstractMacro
Main method of macro. This method is called when this macro is invoked. All subclasses must imlement this method

Specified by:
run in class AbstractMacro
Parameters:
mp - reference to Macroprocessor
params - 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