Package io.github.qishr.cascara.common.util
Interface IHelpCommandInitializable2
java.lang.Object
io.github.qishr.cascara.common.util.CommandLine.IHelpCommandInitializable2
Enclosing Class:
io.github.qishr.cascara.common.util.CommandLine
All Known Implementing Classes:
HelpCommand
public static interface IHelpCommandInitializable2
Help commands that provide usage help for other commands can implement this interface to be initialized with the information they need.
The #executeHelpRequest(List) method calls the
init method on commands marked as Command#helpCommand()
before the help command's run or call method is called.
Implementation note:
If an error occurs in the run or call method while processing the help request, it is recommended custom Help
commands throw a ParameterException with a reference to the parent command.
The DefaultExceptionHandler will print the error message and the usage for the parent command.
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
| public abstract void | init(CommandLine helpCommandLine, ColorScheme colorScheme, PrintWriter outWriter, PrintWriter errWriter) | Initializes this object with the information needed to implement a help command that provides usage help for other commands. |
Method Details
init
public abstract void init(CommandLine helpCommandLine, ColorScheme colorScheme, PrintWriter outWriter, PrintWriter errWriter)
Initializes this object with the information needed to implement a help command that provides usage help for other commands.
Parameters:
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 not
outWriter - the output writer to print the usage help message to
errWriter - the error writer to print any diagnostic messages to, in addition to the output from the exception handler