Package 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.glassfish.hk2.api.PostConstruct

@Service(name="help")
@PerLookup
public class HelpCommand
extends CLICommand

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

Field Summary

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

Constructors

Constructor	Description
HelpCommand()

Method Summary

Modifier and Type	Method	Description
protected int	executeCommand()	Execute the command using the options in options and the operands in operands.

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

checkHelp, checkSanity, execute, expandManPage, getBooleanOption, getBriefCommandUsage, getCommand, getCommand, getCommandScope, getCommandUsage, getManPage, getName, getOperandModel, getOption, getOptions, getPassword, getPassword, getProgramOptions, getSystemProperties, getSystemProperty, getUsage, initializeLogger, initializePasswords, inject, ok, parse, postConstruct, prepare, prevalidate, processProgramOptions, quote, readPassword, setCommandScope, toString, usageOptions, validate

Methods inherited from class java.lang.Object

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

Constructor Details

HelpCommand

public HelpCommand()

Method Details

executeCommand

protected int executeCommand()
                      throws org.glassfish.api.admin.CommandException,
org.glassfish.api.admin.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:

org.glassfish.api.admin.CommandException - if execution of the command fails

org.glassfish.api.admin.CommandValidationException - if there's something wrong with the options or arguments