public interface Subparser extends ArgumentParser
This interface defines Subparser used to add sub-command to
ArgumentParser
.
Modifier and Type | Method and Description |
---|---|
Subparser |
aliases(String... alias)
Sets alias names for this Subparser.
|
Subparser |
defaultHelp(boolean defaultHelp)
If defaultHelp is
true , the default values of arguments are
printed in help message. |
Subparser |
description(String description)
Sets the text to display before the argument help.
|
Subparser |
epilog(String epilog)
Sets the text to display after the argument help.
|
Subparser |
help(String help)
Sets the text to display in help message.
|
Subparser |
setDefault(String dest,
Object value)
Sets parser-level default value of attribute
dest . |
Subparser |
setDefaults(Map<String,Object> attrs)
Sets parser-level default values from
attrs . |
Subparser |
version(String version)
Sets version string.
|
addArgument, addArgumentGroup, addMutuallyExclusiveGroup, addMutuallyExclusiveGroup, addSubparsers, formatHelp, formatUsage, formatVersion, getDefault, handleError, parseArgs, parseArgs, parseArgs, parseArgs, parseArgsOrFail, printHelp, printHelp, printUsage, printUsage, printVersion, printVersion, usage
Subparser description(String description)
ArgumentParser
description
in interface ArgumentParser
description
- The text to display before the argument help.Subparser epilog(String epilog)
ArgumentParser
epilog
in interface ArgumentParser
epilog
- The text to display after the argument help.Subparser version(String version)
ArgumentParser
Sets version string. It will be displayed ArgumentParser.printVersion()
.
If the given usage contains ${prog} string, it will be replaced
with the program name given in
ArgumentParsers.newArgumentParser(String)
. This processed text
will be printed without text-wrapping.
version
in interface ArgumentParser
version
- The version string.Subparser defaultHelp(boolean defaultHelp)
ArgumentParser
If defaultHelp is true
, the default values of arguments are
printed in help message.
By default, the default values are not printed in help message.
defaultHelp
in interface ArgumentParser
defaultHelp
- Switch to display the default value in help message.Subparser setDefault(String dest, Object value)
ArgumentParser
Sets parser-level default value of attribute dest
.
The parser-level defaults always override argument-level defaults.
setDefault
in interface ArgumentParser
dest
- The attribute name.value
- The default value.Subparser setDefaults(Map<String,Object> attrs)
ArgumentParser
Sets parser-level default values from attrs
.
All key-value pair in attrs
are registered to parser-level
defaults. The parser-level defaults always override argument-level
defaults.
setDefaults
in interface ArgumentParser
attrs
- The parser-level default values to add.Subparser help(String help)
help
- The text to display in help message.Subparser aliases(String... alias)
Subparsers
instance which this object belongs to.alias
- Alias name for this Subparser.Copyright © 2012–2018. All rights reserved.