public interface CommandUsageGenerator
Modifier and Type | Method and Description |
---|---|
void |
usage(String programName,
String[] groupNames,
String commandName,
CommandMetadata command)
Deprecated.
Please use the overload that takes the parser configuration
explicitly
|
void |
usage(String programName,
String[] groupNames,
String commandName,
CommandMetadata command,
OutputStream output)
Deprecated.
Please use the overload that takes the parser configuration
explicitly
|
<T> void |
usage(String programName,
String[] groupNames,
String commandName,
CommandMetadata command,
ParserMetadata<T> parserConfig)
Generate the help and output it on standard out
|
<T> void |
usage(String programName,
String[] groupNames,
String commandName,
CommandMetadata command,
ParserMetadata<T> parserConfig,
OutputStream output)
Generate the help and output it to the stream
|
@Deprecated void usage(String programName, String[] groupNames, String commandName, CommandMetadata command) throws IOException
programName
- Program NamegroupNames
- Group Name(s)commandName
- Command Namecommand
- Command MetadataIOException
@Deprecated void usage(String programName, String[] groupNames, String commandName, CommandMetadata command, OutputStream output) throws IOException
programName
- Program NamegroupNames
- Group Name(s)commandName
- Command Namecommand
- Command Metadataout
- Stream to output toIOException
<T> void usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig) throws IOException
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
<T> void usage(String programName, String[] groupNames, String commandName, CommandMetadata command, ParserMetadata<T> parserConfig, OutputStream output) throws IOException
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 helpout
- Stream to output toIOException
Copyright © 2012–2017. All rights reserved.