public abstract class AbstractPrintedCommandGroupUsageGenerator<T> extends AbstractCommandGroupUsageGenerator<T>
UsagePrinter
to generate the documentationDEFAULT_COLUMNS
Constructor and Description |
---|
AbstractPrintedCommandGroupUsageGenerator(int columnSize,
Comparator<? super HelpHint> hintComparator,
Comparator<? super OptionMetadata> optionComparator,
Comparator<? super CommandMetadata> commandComparator,
boolean includeHidden) |
Modifier and Type | Method and Description |
---|---|
protected UsagePrinter |
createUsagePrinter(OutputStream out)
Creates a usage printer for the given stream
|
void |
usage(GlobalMetadata<T> global,
CommandGroupMetadata[] groups,
OutputStream out)
Generate the help and output it to the stream
|
protected abstract void |
usage(GlobalMetadata<T> global,
CommandGroupMetadata[] groups,
UsagePrinter out)
Generate the help and output is using the provided
UsagePrinter |
usage
getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toDescription, toSynopsisUsage, toUsage, toUsage
public AbstractPrintedCommandGroupUsageGenerator(int columnSize, Comparator<? super HelpHint> hintComparator, Comparator<? super OptionMetadata> optionComparator, Comparator<? super CommandMetadata> commandComparator, boolean includeHidden)
protected abstract void usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups, UsagePrinter out) throws IOException
UsagePrinter
global
- Global Metadatagroup
- Group Metadataout
- Usage printer to output withIOException
protected UsagePrinter createUsagePrinter(OutputStream out)
out
- Output streampublic void usage(GlobalMetadata<T> global, CommandGroupMetadata[] groups, OutputStream out) throws IOException
CommandGroupUsageGenerator
global
- Global metadatagroups
- Group path to the commandIOException
Copyright © 2012–2017. All rights reserved.