pmp.macro.str
Class SubStr

java.lang.Object
  extended by pmp.AbstractMacro
      extended by pmp.macro.str.SubStr

public class SubStr
extends AbstractMacro

Returns substring of given string. The first argument contains given string, the second is index of first character (zero-based) to be copied and the third is maximal number of characters to be copied. Length parameter may be omitted - then all characters up to end of string will be copied

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
SubStr()
           
 
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

SubStr

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