public static final class CommandLine.HelpCommand extends Object implements CommandLine.IHelpCommandInitializable, CommandLine.IHelpCommandInitializable2, Runnable
// print help for subcommand command help subcommand
When invoked without additional parameters, it prints usage help for the parent command. For example:
// print help for command command helpFor internationalization: this command has a
--help
option with descriptionKey = "helpCommand.help"
,
and a COMMAND
positional parameter with descriptionKey = "helpCommand.command"
.Constructor and Description |
---|
HelpCommand() |
Modifier and Type | Method and Description |
---|---|
void |
init(CommandLine helpCommandLine,
CommandLine.Help.Ansi ansi,
PrintStream out,
PrintStream err)
Deprecated.
|
void |
init(CommandLine helpCommandLine,
CommandLine.Help.ColorScheme colorScheme,
PrintWriter out,
PrintWriter err)
Initializes this object with the information needed to implement a help command that provides usage help for other commands.
|
void |
run()
Invokes
usage for the specified command, or for the parent command. |
public void run()
usage
for the specified command, or for the parent command.@Deprecated public void init(CommandLine helpCommandLine, CommandLine.Help.Ansi ansi, PrintStream out, PrintStream err)
init
in interface CommandLine.IHelpCommandInitializable
helpCommandLine
- the CommandLine
object associated with this help command. Implementors can use
this to walk the command hierarchy and get access to the help command's parent and sibling commands.ansi
- whether to use Ansi colors or notout
- the stream to print the usage help message toerr
- the error stream to print any diagnostic messages to, in addition to the output from the exception handlerpublic void init(CommandLine helpCommandLine, CommandLine.Help.ColorScheme colorScheme, PrintWriter out, PrintWriter err)
init
in interface CommandLine.IHelpCommandInitializable2
helpCommandLine
- the CommandLine
object associated with this help command. Implementors can use
this to walk the command hierarchy and get access to the help command's parent and sibling commands.colorScheme
- the color scheme to use when printing help, including whether to use Ansi colors or notout
- the output writer to print the usage help message toerr
- the error writer to print any diagnostic messages to, in addition to the output from the exception handler