pmp.macro
Class IsDefined

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

public class IsDefined
extends AbstractMacro

Returns "1" if macro with name specified by first parameter exists and is defined (not builtin). Type of MacroChain is considered to be same as first encapsulated macro.

If more than one parametr is given, then second parametr is returned instead of1 and third parametr is returned otherwise (provided the third parameter is specified).

Title: PMP: Macroprocessor

Description: Java macroprocessor

Copyright: Copyright (c) 2005

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

Field Summary
static int PARAMS_REQUIRED
           
 
Constructor Summary
IsDefined()
           
 
Method Summary
 java.lang.String run(Macroprocessor mp, java.lang.String[] args)
          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

IsDefined

public IsDefined()
Method Detail

run

public java.lang.String run(Macroprocessor mp,
                            java.lang.String[] args)
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
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