public class CliGlobalUsageGenerator<T> extends AbstractPrintedGlobalUsageGenerator<T>
DEFAULT_COLUMNS
Constructor and Description |
---|
CliGlobalUsageGenerator() |
CliGlobalUsageGenerator(boolean includeHidden) |
CliGlobalUsageGenerator(int columns) |
CliGlobalUsageGenerator(int columns,
boolean includeHidden) |
CliGlobalUsageGenerator(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 CliUsageHelper |
createHelper(Comparator<? super OptionMetadata> optionComparator,
boolean includeHidden) |
protected void |
outputCommandDescription(UsagePrinter out,
CommandGroupMetadata group,
CommandMetadata command)
Outputs the description for a command
|
protected void |
outputCommandList(UsagePrinter out,
GlobalMetadata<T> global)
Outputs a documentation section listing the commands
|
protected void |
outputDescription(UsagePrinter out,
GlobalMetadata<T> global)
Outputs a documentation section with a description of the CLI
|
protected void |
outputGroupCommandsList(UsagePrinter out,
GlobalMetadata<T> global,
List<CommandGroupMetadata> groups) |
protected void |
outputSynopsis(UsagePrinter out,
GlobalMetadata<T> global)
Outputs a documentation section with a synopsis of CLI usage
|
protected void |
outputUserAliases(UsagePrinter out,
GlobalMetadata<T> global,
UserAliasesSource<T> userAliases) |
protected 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 CliGlobalUsageGenerator()
public CliGlobalUsageGenerator(boolean includeHidden)
public CliGlobalUsageGenerator(int columns)
public CliGlobalUsageGenerator(int columns, boolean includeHidden)
public CliGlobalUsageGenerator(int columnSize, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, Comparator<? super CommandGroupMetadata> commandGroupComparator, boolean includeHidden)
protected CliUsageHelper createHelper(Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
protected 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 outputCommandList(UsagePrinter out, GlobalMetadata<T> global) throws IOException
out
- Usage printerglobal
- Global meta-dataIOException
protected void outputGroupCommandsList(UsagePrinter out, GlobalMetadata<T> global, List<CommandGroupMetadata> groups) throws IOException
IOException
protected void outputSynopsis(UsagePrinter out, GlobalMetadata<T> global) throws IOException
out
- Usage printerglobal
- Global meta-dataIOException
protected void outputDescription(UsagePrinter out, GlobalMetadata<T> global) throws IOException
out
- Usage printerglobal
- Global meta-dataIOException
protected void outputCommandDescription(UsagePrinter out, CommandGroupMetadata group, CommandMetadata command) throws IOException
out
- Usage printergroup
- Group meta-datacommand
- Command meta-dataIOException
protected void outputUserAliases(UsagePrinter out, GlobalMetadata<T> global, UserAliasesSource<T> userAliases) throws IOException
IOException
Copyright © 2012–2017. All rights reserved.