java.lang.Object
com.github.rvesse.airline.help.common.AbstractUsageGenerator
com.github.rvesse.airline.help.cli.CliUsageHelper
-
Field Summary
Fields inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator
DEFAULT_COLUMNS
-
Constructor Summary
ConstructorsConstructorDescriptionCliUsageHelper
(Comparator<? super OptionMetadata> optionComparator, boolean includeHidden) -
Method Summary
Modifier and TypeMethodDescriptionstatic 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 optionvoid
outputHelpSection
(UsagePrinter out, HelpSection section) Outputs a help sectionprotected 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 optionvoid
outputOptions
(UsagePrinter out, List<OptionMetadata> options) Methods inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator
getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toDescription, toSynopsisUsage, toUsage, toUsage
-
Constructor Details
-
CliUsageHelper
-
-
Method Details
-
outputOptions
- Throws:
IOException
-
outputOptionRestriction
protected void outputOptionRestriction(UsagePrinter out, OptionMetadata option, OptionRestriction restriction, HelpHint hint) throws IOException Outputs documentation about a restriction on an option- Parameters:
out
- Usage printeroption
- Option meta-datarestriction
- Restrictionhint
- Help hint- Throws:
IOException
-
outputHint
- Throws:
IOException
-
calculateMaxRows
-
outputArguments
public <T> void outputArguments(UsagePrinter out, ArgumentsMetadata arguments, ParserMetadata<T> parserConfig) throws IOException - Throws:
IOException
-
outputArgumentsRestriction
protected void outputArgumentsRestriction(UsagePrinter descriptionPrinter, ArgumentsMetadata arguments, ArgumentsRestriction restriction, HelpHint hint) throws IOException Outputs documentation about a restriction on an option- Parameters:
descriptionPrinter
- Description printerarguments
- Arguments meta-datarestriction
- Restrictionhint
- Help hint- Throws:
IOException
-
outputHelpSection
Outputs a help section- Parameters:
out
- Usage printersection
- Help section- Throws:
IOException
-