Module com.github.rvesse.airline
Class CliGlobalUsageSummaryGenerator<T>
java.lang.Object
com.github.rvesse.airline.help.common.AbstractUsageGenerator
com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator<T>
com.github.rvesse.airline.help.common.AbstractPrintedGlobalUsageGenerator<T>
com.github.rvesse.airline.help.cli.CliGlobalUsageSummaryGenerator<T>
- All Implemented Interfaces:
GlobalUsageGenerator<T>
-
Field Summary
FieldsFields inherited from class com.github.rvesse.airline.help.common.AbstractUsageGenerator
DEFAULT_COLUMNS
-
Constructor Summary
ConstructorsConstructorDescriptionCliGlobalUsageSummaryGenerator
(boolean includeHidden) CliGlobalUsageSummaryGenerator
(int columnSize) CliGlobalUsageSummaryGenerator
(int columnSize, boolean includeHidden) CliGlobalUsageSummaryGenerator
(int columnSize, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden) -
Method Summary
Modifier and TypeMethodDescriptionprotected CliUsageHelper
createHelper
(Comparator<? super OptionMetadata> optionComparator, boolean includeHidden) protected void
outputCommandList
(UsagePrinter out, GlobalMetadata<T> global) Outputs a documentation section listing the common commands and groupsprotected void
outputFooter
(UsagePrinter out, GlobalMetadata<T> global) Outputs a documentation section detailing how to get more helpprotected void
outputSynopsis
(UsagePrinter out, GlobalMetadata<T> global) Outputs a documentation section with a brief synopsis of usagevoid
usage
(GlobalMetadata<T> global, UsagePrinter out) Generate the help and output is using the providedUsagePrinter
Methods inherited from class com.github.rvesse.airline.help.common.AbstractPrintedGlobalUsageGenerator
createUsagePrinter, usage
Methods inherited from class com.github.rvesse.airline.help.common.AbstractGlobalUsageGenerator
findHelpSections, sortCommandGroups, usage
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
-
Field Details
-
helper
-
-
Constructor Details
-
CliGlobalUsageSummaryGenerator
public CliGlobalUsageSummaryGenerator() -
CliGlobalUsageSummaryGenerator
public CliGlobalUsageSummaryGenerator(boolean includeHidden) -
CliGlobalUsageSummaryGenerator
public CliGlobalUsageSummaryGenerator(int columnSize) -
CliGlobalUsageSummaryGenerator
public CliGlobalUsageSummaryGenerator(int columnSize, boolean includeHidden) -
CliGlobalUsageSummaryGenerator
public CliGlobalUsageSummaryGenerator(int columnSize, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden)
-
-
Method Details
-
createHelper
protected CliUsageHelper createHelper(Comparator<? super OptionMetadata> optionComparator, boolean includeHidden) -
usage
Description copied from class:AbstractPrintedGlobalUsageGenerator
Generate the help and output is using the providedUsagePrinter
- Specified by:
usage
in classAbstractPrintedGlobalUsageGenerator<T>
- Parameters:
global
- Global Metadataout
- Usage printer to output with- Throws:
IOException
- Thrown if there is a problem generating usage output
-
outputCommandList
Outputs a documentation section listing the common commands and groups- Parameters:
out
- Usage printerglobal
- Global meta-data- Throws:
IOException
-
outputSynopsis
Outputs a documentation section with a brief synopsis of usage- Parameters:
out
- Usage printerglobal
- Global meta-data- Throws:
IOException
-