public class CliUsageHelper extends AbstractUsageGenerator
DEFAULT_COLUMNS
Constructor and Description |
---|
CliUsageHelper(Comparator<? super OptionMetadata> optionComparator,
boolean includeHidden) |
Modifier and Type | Method and Description |
---|---|
static int |
calculateMaxRows(HelpHint hint) |
<T> void |
outputArguments(UsagePrinter out,
ArgumentsMetadata arguments,
ParserMetadata<T> parserConfig) |
protected void |
outputArgumentsRestriction(UsagePrinter descriptionPrinter,
ArgumentsMetadata arguments,
ArgumentsRestriction restriction,
HelpHint hint)
Outputs documentation about a restriction on an option
|
void |
outputHelpSection(UsagePrinter out,
HelpSection section)
Outputs a help section
|
protected void |
outputHint(UsagePrinter out,
HelpHint hint,
boolean newPara) |
protected void |
outputOptionRestriction(UsagePrinter out,
OptionMetadata option,
OptionRestriction restriction,
HelpHint hint)
Outputs documentation about a restriction on an option
|
void |
outputOptions(UsagePrinter out,
List<OptionMetadata> options) |
getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toDescription, toSynopsisUsage, toUsage, toUsage
public CliUsageHelper(Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
public void outputOptions(UsagePrinter out, List<OptionMetadata> options) throws IOException
IOException
protected void outputOptionRestriction(UsagePrinter out, OptionMetadata option, OptionRestriction restriction, HelpHint hint) throws IOException
out
- Usage printeroption
- Option meta-datarestriction
- Restrictionhint
- Help hintIOException
protected void outputHint(UsagePrinter out, HelpHint hint, boolean newPara) throws IOException
IOException
public static int calculateMaxRows(HelpHint hint)
public <T> void outputArguments(UsagePrinter out, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig) throws IOException
IOException
protected void outputArgumentsRestriction(UsagePrinter descriptionPrinter, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint) throws IOException
descriptionPrinter
- Description printerarguments
- Arguments meta-datarestriction
- Restrictionhint
- Help hintIOException
public void outputHelpSection(UsagePrinter out, HelpSection section) throws IOException
out
- Usage printersection
- Help sectionIOException
Copyright © 2012–2017. All rights reserved.