public class HelpOption<C> extends Object
Constructor and Description |
---|
HelpOption() |
Modifier and Type | Method and Description |
---|---|
void |
showHelp()
Shows help using the default
CliCommandUsageGenerator |
void |
showHelp(CommandUsageGenerator generator)
Shows help using the given usage generator
|
<T> boolean |
showHelpIfErrors(ParseResult<T> result)
Shows help if any parsing errors were detected.
|
<T> boolean |
showHelpIfErrors(ParseResult<T> result,
boolean printErrors)
Shows help if any parsing errors were detected
|
<T> boolean |
showHelpIfErrors(ParseResult<T> result,
boolean printErrors,
CommandUsageGenerator generator)
Shows help if any parsing errors were detected
|
boolean |
showHelpIfRequested()
Shows help if user requested it and it hasn't already been shown using
the default
CliCommandUsageGenerator |
boolean |
showHelpIfRequested(CommandUsageGenerator generator)
Shows help if user requested it and it hasn't already been shown
|
@Option(name={"-h","--help"}, description="Display help information") public Boolean help
public boolean showHelpIfRequested()
CliCommandUsageGenerator
public boolean showHelpIfRequested(CommandUsageGenerator generator)
generator
- Usage generatorpublic <T> boolean showHelpIfErrors(ParseResult<T> result)
result
- Parsing result, if null
then this method does nothingpublic <T> boolean showHelpIfErrors(ParseResult<T> result, boolean printErrors)
result
- Parsing result, if null
then this method does nothingprintErrors
- Whether to print error messages prior to the help, set to
false
if your code has already done thatpublic <T> boolean showHelpIfErrors(ParseResult<T> result, boolean printErrors, CommandUsageGenerator generator)
result
- Parsing result, if null
then this method does nothingprintErrors
- Whether to print error messages prior to the help, set to
false
if your code has already done thatgenerator
- Command generator for printing the helppublic void showHelp()
CliCommandUsageGenerator
public void showHelp(CommandUsageGenerator generator)
generator
- Usage generatorCopyright © 2012–2017. All rights reserved.