Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.hyperic.sigar.shell
Class ShellCommand_help

    java.lang.Object
      org.hyperic.sigar.shell.ShellCommandBase
          org.hyperic.sigar.shell.ShellCommand_help

All Implemented Interfaces:
  ShellCommandHandler

    public class ShellCommand_help

extends ShellCommandBase

Field Summary

Fields inherited from class org.hyperic.sigar.shell.ShellCommandBase
`itsCommandName, itsShell`

Constructor Summary
`ShellCommand_help()`

Method Summary
`java.lang.String` | `getSyntaxArgs()`
`java.lang.String` | `getUsageHelp(java.lang.String[] args)` Get some info on how to invoke this command.
`java.lang.String` | `getUsageShort()` Get a very brief (40 character) description of the command
`void` | `processCommand(java.lang.String[] args)` Handle a command.

Methods inherited from class org.hyperic.sigar.shell.ShellCommandBase
`getCommandName, getErrStream, getOutStream, getShell, getSyntax, init`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### ShellCommand_help

    public ShellCommand_help()

Method Detail

### processCommand

    public void processCommand(java.lang.String[] args)
                        throws ShellCommandUsageException,
                               ShellCommandExecException

  Description copied from interface: `ShellCommandHandler`
  Handle a command.

  Specified by:
    `processCommand` in interface `ShellCommandHandler`
  Overrides:
    `processCommand` in class `ShellCommandBase`
  Parameters:
    `args` - The args to the command.
  Throws:
    `ShellCommandUsageException` - If the args are malformed.
    `ShellCommandExecException` - If an error occurred executing the command.

### getSyntaxArgs

    public java.lang.String getSyntaxArgs()

  Overrides:
    `getSyntaxArgs` in class `ShellCommandBase`

### getUsageShort

    public java.lang.String getUsageShort()

  Description copied from interface: `ShellCommandHandler`
  Get a very brief (40 character) description of the command

  Specified by:
    `getUsageShort` in interface `ShellCommandHandler`
  Overrides:
    `getUsageShort` in class `ShellCommandBase`
  Returns:
    A description of the command.

### getUsageHelp

    public java.lang.String getUsageHelp(java.lang.String[] args)

  Description copied from interface: `ShellCommandHandler`
  Get some info on how to invoke this command.

  Specified by:
    `getUsageHelp` in interface `ShellCommandHandler`
  Overrides:
    `getUsageHelp` in class `ShellCommandBase`
  Returns:
    Some usage information on how this command is expected to be invoked.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright ? 2004-2009 Hyperic. All Rights Reserved.