pmp.macro.tools
Class Pause

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

public class Pause
extends AbstractMacro

Pauses for given amount of time or until key is pressed if no value is given. First parameter contains time to wait in milliseconds.

The second parameter specifies mode of interaction with standard input. See description of fields of this class for details.

Note: Waiting for keypress doesn't work when invoked from Ant.

If given value is greater than 1000, System.gc() is invoked.

Title: PMP: Macroprocessor

Description: Java macroprocessor

Copyright: Copyright (c) 2005

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

Field Summary
static java.lang.String INTR
          Waits until elapses given amount of time or until keypress.
static int PARAMS_REQUIRED
           
static java.lang.String SLEEP
          Waits for given amount of time and then exits (default mode).
static java.lang.String WAIT
          Waits for given amount of time and then waits for keypress.
 
Constructor Summary
Pause()
           
 
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

SLEEP

public static final java.lang.String SLEEP
Waits for given amount of time and then exits (default mode).

See Also:
Constant Field Values

WAIT

public static final java.lang.String WAIT
Waits for given amount of time and then waits for keypress.

See Also:
Constant Field Values

INTR

public static final java.lang.String INTR
Waits until elapses given amount of time or until keypress.

See Also:
Constant Field Values
Constructor Detail

Pause

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