org.jboss.as.cli.handlers

Class HelpHandler

java.lang.Object

org.jboss.as.cli.handlers.CommandHandlerWithArguments

org.jboss.as.cli.handlers.CommandHandlerWithHelp

org.jboss.as.cli.handlers.HelpHandler

All Implemented Interfaces:

CommandHandler

public class HelpHandler
extends CommandHandlerWithHelp

Help command handler. Reads 'help/help.txt' and prints its content to the output stream.

Author:

Alexey Loubyansky

Field Summary

Fields inherited from class org.jboss.as.cli.handlers.CommandHandlerWithHelp

helpArg

Constructor Summary

Constructors

Constructor and Description
HelpHandler(CommandRegistry cmdRegistry)
HelpHandler(String command, CommandRegistry cmdRegistry)

Method Summary

Modifier and Type	Method and Description
protected void	doHandle(CommandContext ctx)
void	handle(CommandContext ctx) Executes the command.

Methods inherited from class org.jboss.as.cli.handlers.CommandHandlerWithHelp

isAvailable, isBatchMode, printHelp, printList

Methods inherited from class org.jboss.as.cli.handlers.CommandHandlerWithArguments

addArgument, getArgument, getArguments, hasArgument, hasArgument, recognizeArguments

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpHandler

public HelpHandler(CommandRegistry cmdRegistry)

HelpHandler

public HelpHandler(String command,
                   CommandRegistry cmdRegistry)

Method Detail

handle

public void handle(CommandContext ctx)
            throws CommandLineException

Description copied from interface: CommandHandler

Executes the command.

Specified by:

handle in interface CommandHandler

Overrides:

handle in class CommandHandlerWithHelp

Parameters:

ctx - current command context

Throws:

CommandLineException - if for any reason the command can't be properly handled the implementation must throw an instance of CommandLineException.

doHandle

protected void doHandle(CommandContext ctx)

Specified by:

doHandle in class CommandHandlerWithHelp