org.objectweb.dsrg.sofa.cushion
Class HelpAction

java.lang.Object
  extended by org.objectweb.dsrg.sofa.cushion.HelpAction
All Implemented Interfaces:
ActionInterface

public class HelpAction
extends java.lang.Object
implements ActionInterface

Prints help for all actions.

Author:
Tomas Bures

Field Summary
 
Fields inherited from interface org.objectweb.dsrg.sofa.cushion.ActionInterface
ACTION_ERROR, BAD_PARAMETERS, NOT_ENOUGH_PARAMETERS, SUCCESS, TOO_MANY_PARAMETERS
 
Constructor Summary
HelpAction()
           
 
Method Summary
 int perform(java.lang.String[] args, java.io.PrintStream out)
          Performs action.
protected  void printActionList(java.lang.StringBuffer buffer)
          Prints list of available actions.
 void printHelp(java.lang.StringBuffer msg)
          Prints help.
 void printUsage(java.lang.StringBuffer msg)
          Prints usage.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HelpAction

public HelpAction()
Method Detail

perform

public int perform(java.lang.String[] args,
                   java.io.PrintStream out)
Performs action.

Specified by:
perform in interface ActionInterface
Parameters:
args - command line parameters
out - output stream

printHelp

public void printHelp(java.lang.StringBuffer msg)
Prints help.

Specified by:
printHelp in interface ActionInterface
Parameters:
msg - buffer to which help message is printed
See Also:
ActionInterface.printHelp(StringBuffer)

printUsage

public void printUsage(java.lang.StringBuffer msg)
Prints usage.

Specified by:
printUsage in interface ActionInterface
Parameters:
msg - buffer to which help message is printed
See Also:
ActionInterface.printUsage(StringBuffer)

printActionList

protected void printActionList(java.lang.StringBuffer buffer)
Prints list of available actions.

Parameters:
buffer - output stream.