jhomenet.server.console.command
Class PersistDataCommand

java.lang.Object
  extended by jhomenet.server.console.command.AbstractCommand
      extended by jhomenet.server.console.command.PersistDataCommand
All Implemented Interfaces:
Command

public class PersistDataCommand
extends AbstractCommand

TODO: Class description.

Id: $Id: $

Author:
Dave Irwin (jhomenet at gmail dot com)

Field Summary
 
Fields inherited from class jhomenet.server.console.command.AbstractCommand
serverContext
 
Constructor Summary
PersistDataCommand(ServerContext serverContext)
          Constructor.
 
Method Summary
 void execute(SystemInputStream in, SystemPrintStream out, SystemPrintStream err, java.lang.String[] args, java.util.Map env)
          Executes this command.
 java.lang.String getCommandName()
          Get the command name to be used to execute the command on the command line.
 java.lang.String getUsageString()
          Returns a string describing the usage of the command and its arguments if any.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PersistDataCommand

public PersistDataCommand(ServerContext serverContext)
Constructor.

Parameters:
hardwareManager -
workQueue -
Method Detail

execute

public void execute(SystemInputStream in,
                    SystemPrintStream out,
                    SystemPrintStream err,
                    java.lang.String[] args,
                    java.util.Map env)
             throws java.lang.Exception
Description copied from interface: Command
Executes this command.

Parameters:
in - The input stream this command will use to receive input.
out - The print stream this command should use to report any non-critical messages.
err - The print stream this command should use to report any critical messages.
args - The list of arguments given when this command was invoked. This does not include the command location itself.
env - A windDirectionTable of properties variables.
Throws:
java.lang.Exception - Any exception raised by the underlying command. The getMessage() method of this exception should be as descriptive as possible since the SLUSH shell will use it to report the exception back to the user.
See Also:
Command.execute(jhomenet.server.console.io.SystemInputStream, jhomenet.server.console.io.SystemPrintStream, jhomenet.server.console.io.SystemPrintStream, java.lang.String[], java.util.Map)

getUsageString

public java.lang.String getUsageString()
Description copied from interface: Command
Returns a string describing the usage of the command and its arguments if any.

Returns:
the usage.
See Also:
Command.getUsageString()

getCommandName

public java.lang.String getCommandName()
Description copied from interface: Command
Get the command name to be used to execute the command on the command line.

Returns:
See Also:
Command.getCommandName()


Copyright © 2004-2007 David Irwin. All Rights Reserved.