public class CliGlobalUsageSummaryGenerator<T> extends AbstractPrintedGlobalUsageGenerator<T>
DEFAULT_COLUMNS
Constructor and Description |
---|
CliGlobalUsageSummaryGenerator() |
CliGlobalUsageSummaryGenerator(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) |
Modifier and Type | Method and Description |
---|---|
protected void |
outputCommandList(UsagePrinter out,
GlobalMetadata<T> global)
Outputs a documentation section listing the common commands and groups
|
protected void |
outputFooter(UsagePrinter out,
GlobalMetadata<T> global)
Outputs a documentation section detailing how to get more help
|
protected void |
outputSynopsis(UsagePrinter out,
GlobalMetadata<T> global)
Outputs a documentation section with a brief synopsis of usage
|
void |
usage(GlobalMetadata<T> global,
UsagePrinter out)
Generate the help and output is using the provided
UsagePrinter |
createUsagePrinter, usage
sortCommandGroups, usage
getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toDescription, toSynopsisUsage, toUsage, toUsage
public CliGlobalUsageSummaryGenerator()
public CliGlobalUsageSummaryGenerator(boolean includeHidden)
public CliGlobalUsageSummaryGenerator(int columnSize)
public CliGlobalUsageSummaryGenerator(int columnSize, boolean includeHidden)
public CliGlobalUsageSummaryGenerator(int columnSize, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden)
public void usage(GlobalMetadata<T> global, UsagePrinter out) throws IOException
AbstractPrintedGlobalUsageGenerator
UsagePrinter
usage
in class AbstractPrintedGlobalUsageGenerator<T>
global
- Global Metadataout
- Usage printer to output withIOException
protected void outputFooter(UsagePrinter out, GlobalMetadata<T> global) throws IOException
out
- Usage printerglobal
- Global meta-dataIOException
protected void outputCommandList(UsagePrinter out, GlobalMetadata<T> global) throws IOException
out
- Usage printerglobal
- Global meta-dataIOException
protected void outputSynopsis(UsagePrinter out, GlobalMetadata<T> global) throws IOException
out
- Usage printerglobal
- Global meta-dataIOException
Copyright © 2012–2017. All rights reserved.