com.sun.enterprise.admin.cli
Class HelpCommand

java.lang.Object
  com.sun.enterprise.admin.cli.CLICommand
      com.sun.enterprise.admin.cli.HelpCommand

All Implemented Interfaces:

org.jvnet.hk2.component.PostConstruct

@Service(name="help")
@Scoped(value=org.jvnet.hk2.component.PerLookup.class)
public class HelpCommand
extends CLICommand

The help command will display the help text for all the commands and their options

Field Summary

private String	cmd
private static String	DEFAULT_HELP_PAGE
private static int	DEFAULT_PAGE_LENGTH
private org.jvnet.hk2.component.Habitat	habitat
private static int	NO_PAGE_LENGTH
private static LocalStringsImpl	strings

Fields inherited from class com.sun.enterprise.admin.cli.CLICommand

argv, commandModel, CONNECTION_ERROR, env, ERROR, INVALID_COMMAND_ERROR, logger, metadataErrors, name, operands, options, passwords, programOpts, SUCCESS, WARNING

Constructor Summary

HelpCommand()

Method Summary

protected int	executeCommand() Execute the command using the options in options and the operands in operands.
private String	getCommandName()
private Writer	getDestination()
private int	getPageLength()
private String	getPrompt()
private String	getQuitChar()
private Reader	getSource()
private Reader	getUserInput()
private Writer	getUserOutput()

Methods inherited from class com.sun.enterprise.admin.cli.CLICommand

checkHelp, execute, getBooleanOption, getCommand, getManPage, getName, getOperandModel, getOption, getPassword, getProgramOptions, getSystemProperties, getSystemProperty, getUsage, initializeLogger, initializePasswords, inject, ok, parse, postConstruct, prepare, prevalidate, printExceptionStackTrace, processProgramOptions, quote, readPassword, toString, usageOptions, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

habitat

private org.jvnet.hk2.component.Habitat habitat

DEFAULT_PAGE_LENGTH

private static final int DEFAULT_PAGE_LENGTH

See Also:

Constant Field Values

NO_PAGE_LENGTH

private static final int NO_PAGE_LENGTH

See Also:

Constant Field Values

DEFAULT_HELP_PAGE

private static final String DEFAULT_HELP_PAGE

See Also:

Constant Field Values

strings

private static final LocalStringsImpl strings

cmd

private String cmd

Constructor Detail

HelpCommand

public HelpCommand()

Method Detail

executeCommand

protected int executeCommand()
                      throws CommandException,
                             CommandValidationException

Description copied from class: CLICommand

Execute the command using the options in options and the operands in operands.

Specified by:

executeCommand in class CLICommand

Returns:

the exit code

Throws:

CommandException - if execution of the command fails

CommandValidationException - if there's something wrong with the options or arguments

getCommandName

private String getCommandName()

getDestination

private Writer getDestination()

getPageLength

private int getPageLength()

getPrompt

private String getPrompt()

getQuitChar

private String getQuitChar()

getSource

private Reader getSource()
                  throws CommandException,
                         CommandValidationException

Throws:

CommandException

CommandValidationException

getUserInput

private Reader getUserInput()

getUserOutput

private Writer getUserOutput()