pmp.macro.tools
Class GetProperty

java.lang.Object
  extended by pmp.AbstractMacro
      extended by pmp.macro.tools.GetProperty

public class GetProperty
extends AbstractMacro

Returns value of system property passed in first parameter. Default value might be given in the second parameter.

Title: PMP: Macroprocessor

Description: Java macroprocessor

Copyright: Copyright (c) 2005

Version:
1.0
Author:
Luděk Hlaváček
See Also:
System.getProperty(java.lang.String), System.getProperty(java.lang.String, java.lang.String)

Field Summary
 
Fields inherited from class pmp.AbstractMacro
PARAMS_REQUIRED
 
Constructor Summary
GetProperty()
           
 
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
 

Constructor Detail

GetProperty

public GetProperty()
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