de.uniba.wiai.lspi.util.console
Class ExecuteMacro

java.lang.Object
  extended by de.uniba.wiai.lspi.util.console.Command
      extended by de.uniba.wiai.lspi.util.console.ExecuteMacro

public class ExecuteMacro
extends Command

This is an implementation of Command that allows the execution of commands stored in a .txt file. Every line of the file must be a valid command for the console, from that this command is executed. The file must not contain empty lines. The file is provided with help of the file parameter. To make sure the file is found the complete path has to be provided. On Windows systems the \ must be replaced by /.


Field Summary
static String COMMAND_NAME
          The name of this command.
static String FILE_PARAM
          The name of the parameter for the file name.
static String TIMES_PARAM
          The number of times that the Macro is executed.
 
Fields inherited from class de.uniba.wiai.lspi.util.console.Command
HELP_ARG1, HELP_ARG2, out, parameters, toCommand
 
Constructor Summary
ExecuteMacro(Object[] toCommand, PrintStream out)
          Creates a new instance of ExecuteMacro
 
Method Summary
 void exec()
          To be overwritten by subclasses for command execution.
 String getCommandName()
          Return the name of the command.
 void printOutHelp()
          To be overwritten.
 
Methods inherited from class de.uniba.wiai.lspi.util.console.Command
addParameter, execute, setParameters, setPrintStream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMMAND_NAME

public static final String COMMAND_NAME
The name of this command.

See Also:
Constant Field Values

FILE_PARAM

public static final String FILE_PARAM
The name of the parameter for the file name.

See Also:
Constant Field Values

TIMES_PARAM

public static final String TIMES_PARAM
The number of times that the Macro is executed.

See Also:
Constant Field Values
Constructor Detail

ExecuteMacro

public ExecuteMacro(Object[] toCommand,
                    PrintStream out)
Creates a new instance of ExecuteMacro

Parameters:
toCommand -
out -
Method Detail

printOutHelp

public void printOutHelp()
Description copied from class: Command
To be overwritten. Display the help text of the Command.

Specified by:
printOutHelp in class Command

getCommandName

public String getCommandName()
Description copied from class: Command
Return the name of the command. Must not contain spaces. To be overwritten by subclasses.

Specified by:
getCommandName in class Command
Returns:
The commands name. For example: exit.

exec

public void exec()
          throws ConsoleException
Description copied from class: Command
To be overwritten by subclasses for command execution. The work of a command implementation is done in this method.

Specified by:
exec in class Command
Throws:
ConsoleException - Exception during execution.


Copyright © 2004-2008 Karsten Loesing, Sven Kaffille - Distributed and Mobile Systems Group, Lehrstuhl für Praktische Informatik, Universität Bamberg. All Rights Reserved.