public abstract class AbstractPrintedCommandUsageGenerator extends AbstractCommandUsageGenerator
UsagePrinter
to generate the documentationDEFAULT_COLUMNS
Constructor and Description |
---|
AbstractPrintedCommandUsageGenerator(int columns,
Comparator<? super OptionMetadata> optionComparator,
boolean includeHidden) |
Modifier and Type | Method and Description |
---|---|
protected UsagePrinter |
createUsagePrinter(OutputStream out)
Creates a usage printer for the given stream
|
<T> void |
usage(String programName,
String[] groupNames,
String commandName,
CommandMetadata command,
ParserMetadata<T> parserConfig,
OutputStream out)
Generate the help and output it to the stream
|
abstract <T> void |
usage(String programName,
String[] groupNames,
String commandName,
CommandMetadata command,
ParserMetadata<T> parserConfig,
UsagePrinter out)
Generate the help and output it using the provided
UsagePrinter |
findHelpSections, sortExitCodes, usage, usage, usage
getCommandComparator, getOptionComparator, htmlize, includeHidden, sortArgumentsRestrictions, sortCommands, sortOptionRestrictions, sortOptions, toDefaultCommand, toDescription, toDescription, toSynopsisUsage, toUsage, toUsage
public AbstractPrintedCommandUsageGenerator(int columns, Comparator<? super OptionMetadata> optionComparator, boolean includeHidden)
public abstract <T> void usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, UsagePrinter out) throws IOException
UsagePrinter
programName
- Program NamegroupNames
- Group Name(s)commandName
- Command Namecommand
- Command Metadataout
- Usage printer to output withIOException
protected UsagePrinter createUsagePrinter(OutputStream out)
out
- Output streampublic <T> void usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, OutputStream out) throws IOException
CommandUsageGenerator
programName
- Program NamegroupNames
- Group Name(s)commandName
- Command Namecommand
- Command MetadataparserConfig
- Parser Configuration, if null
is passed then the
parser configuration is automatically determined based on the
command class for which we are producing helpIOException
Copyright © 2012–2017. All rights reserved.