Package org.jboss.as.cli.impl.aesh

Class HelpSupport

java.lang.Object

org.jboss.as.cli.impl.aesh.HelpSupport

public class HelpSupport
extends Object

Entry point for help handling. Aesh based commands have their help generated. For legacy command, static help text files are used.

Author:

jdenise@redhat.com

Field Summary

Fields

Modifier and Type	Field	Description
static String	NULL_DESCRIPTION

Constructor Summary

Constructors

Constructor	Description
HelpSupport()

Method Summary

Modifier and Type	Method	Description
static void	checkCommand(org.aesh.command.impl.parser.CommandLineParser<CLICommandInvocation> parent, org.aesh.command.impl.parser.CommandLineParser<CLICommandInvocation> child)
static String	format(CommandContext ctx, BufferedReader reader)
static Class<?>	getClassFromType(org.jboss.dmr.ModelType mt)
static String	getCommandHelp(org.aesh.command.impl.parser.CommandLineParser<CLICommandInvocation> parser)
static String	getLegacyHelpPath(String commandName)
static String	getSubCommandHelp(String parentCommand, org.aesh.command.impl.parser.CommandLineParser<CLICommandInvocation> parser)
static void	printHelp(CommandContext ctx)
static String	printHelp(CommandContext ctx, String filename)
static String	printHelp(CommandContext ctx, org.jboss.dmr.ModelNode mn, OperationRequestAddress address)

Methods inherited from class java.lang.Object

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

Field Detail

NULL_DESCRIPTION

public static final String NULL_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

HelpSupport

public HelpSupport()

Method Detail

printHelp

public static void printHelp(CommandContext ctx)

printHelp

public static String printHelp(CommandContext ctx,
                               String filename)

getLegacyHelpPath

public static String getLegacyHelpPath(String commandName)

format

public static String format(CommandContext ctx,
                            BufferedReader reader)
                     throws IOException

Throws:

IOException

getClassFromType

public static Class<?> getClassFromType(org.jboss.dmr.ModelType mt)

printHelp

public static String printHelp(CommandContext ctx,
                               org.jboss.dmr.ModelNode mn,
                               OperationRequestAddress address)

getSubCommandHelp

public static String getSubCommandHelp(String parentCommand,
                                       org.aesh.command.impl.parser.CommandLineParser<CLICommandInvocation> parser)

getCommandHelp

public static String getCommandHelp(org.aesh.command.impl.parser.CommandLineParser<CLICommandInvocation> parser)

checkCommand

public static void checkCommand(org.aesh.command.impl.parser.CommandLineParser<CLICommandInvocation> parent,
                                org.aesh.command.impl.parser.CommandLineParser<CLICommandInvocation> child)
                         throws Exception

Throws:

Exception