public class CliCommandGroupUsageGenerator<T> extends AbstractPrintedCommandGroupUsageGenerator<T>
DEFAULT_COLUMNS
Constructor and Description |
---|
CliCommandGroupUsageGenerator() |
CliCommandGroupUsageGenerator(boolean includeHidden) |
CliCommandGroupUsageGenerator(int columns) |
CliCommandGroupUsageGenerator(int columns,
boolean includeHidden) |
CliCommandGroupUsageGenerator(int columns,
boolean hideGlobalOptions,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
boolean includeHidden) |
Modifier and Type | Method and Description |
---|---|
protected void |
outputDescription(UsagePrinter out,
GlobalMetadata<T> global,
CommandGroupMetadata[] groups)
Outputs a description of the group
|
protected void |
outputOptions(UsagePrinter out,
GlobalMetadata<T> global,
CommandGroupMetadata[] groups)
Outputs a documentation section detailing the available options and their
usages
|
protected void |
outputSynopsis(UsagePrinter out,
GlobalMetadata<T> global,
CommandGroupMetadata[] groups)
Outputs a documentation section detailing a usage synopsis
|
protected void |
usage(GlobalMetadata<T> global,
CommandGroupMetadata[] groups,
UsagePrinter out)
Generate the help and output is using the provided
UsagePrinter |
createUsagePrinter, usage
usage
getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toDescription, toSynopsisUsage, toUsage, toUsage
public CliCommandGroupUsageGenerator()
public CliCommandGroupUsageGenerator(boolean includeHidden)
public CliCommandGroupUsageGenerator(int columns)
public CliCommandGroupUsageGenerator(int columns, boolean includeHidden)
public CliCommandGroupUsageGenerator(int columns, boolean hideGlobalOptions, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, boolean includeHidden)
protected void usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups, UsagePrinter out) throws IOException
AbstractPrintedCommandGroupUsageGenerator
UsagePrinter
usage
in class AbstractPrintedCommandGroupUsageGenerator<T>
global
- Global Metadataout
- Usage printer to output withIOException
protected void outputOptions(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups) throws IOException
out
- Usage printerglobal
- Global meta-datagroups
- Group(s) meta-dataIOException
protected void outputSynopsis(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups) throws IOException
out
- Usage printerglobal
- Global meta-datagroup
- Group meta-dataIOException
protected void outputDescription(UsagePrinter out, GlobalMetadata<T> global, CommandGroupMetadata[] groups) throws IOException
out
- Usage printerglobal
- Global meta-datagroup
- Group meta-dataIOException
Copyright © 2012–2017. All rights reserved.