Class SubparsersImpl
- All Implemented Interfaces:
Subparsers
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAlias
(SubparserImpl subparser, String... alias) Adds Subparser alias names for given Subparser.Adds and returnsSubparser
object with given sub-command name.Adds and returnsSubparser
object with given sub-command name and addHelp.Adds and returnsSubparser
object with given sub-command name, addHelp and prefixChars.description
(String description) Sets the text to display to briefly describe sub-commands in the help message.Sets the name of attribute which the selected command name is stored.Returns collection of the sub-command name under this object.getTitle()
boolean
Sets the text to display in the help message for sub-commands.Sets the text used to represent sub-commands in help messages.void
parseArg
(ParseState state, Map<String, Object> opts) void
printSubparserHelp
(PrintWriter writer, int format_width) Writes the help message for this and descendants.Sets the text to display as a title of sub-commands in the help message.
-
Constructor Details
-
SubparsersImpl
-
-
Method Details
-
addParser
Description copied from interface:Subparsers
Adds and returns
Subparser
object with given sub-command name. The given command must be unique for each Subparsers instance.The prefixChars is inherited from main ArgumentParser.
- Specified by:
addParser
in interfaceSubparsers
- Parameters:
command
- Sub-command name- Returns:
Subparser
object.
-
addParser
Description copied from interface:Subparsers
Adds and returns
Subparser
object with given sub-command name and addHelp. The given command must be unique for each Subparsers instance.For
addHelp
, seeArgumentParsers.newArgumentParser(String, boolean, String)
. The prefixChars is inherited from main ArgumentParser.- Specified by:
addParser
in interfaceSubparsers
- Parameters:
command
- Sub-command nameaddHelp
- If true,-h/--help
are available. If false, they are not.- Returns:
Subparser
object
-
addParser
Description copied from interface:Subparsers
Adds and returns
Subparser
object with given sub-command name, addHelp and prefixChars. The given command must be unique for each Subparsers instance.For
addHelp
, seeArgumentParsers.newArgumentParser(String, boolean, String)
.- Specified by:
addParser
in interfaceSubparsers
- Parameters:
command
- Sub-command nameaddHelp
- If true,-h/--help
are available. If false, they are not.prefixChars
- The set of characters that prefix optional arguments.- Returns:
Subparser
object
-
dest
Description copied from interface:Subparsers
Sets the name of attribute which the selected command name is stored.- Specified by:
dest
in interfaceSubparsers
- Parameters:
dest
- The name of attribute the selected command name is stored.- Returns:
- this.
-
help
Description copied from interface:Subparsers
Sets the text to display in the help message for sub-commands.- Specified by:
help
in interfaceSubparsers
- Parameters:
help
- The text to display in the help message.- Returns:
- this
-
title
Description copied from interface:Subparsers
Sets the text to display as a title of sub-commands in the help message.
If either title or description(
Subparsers.description(String)
) is specified, sub-command help will be displayed in its own group.- Specified by:
title
in interfaceSubparsers
- Parameters:
title
- The text to display as a title of sub-commands- Returns:
- this
-
getTitle
-
description
Description copied from interface:Subparsers
Sets the text to display to briefly describe sub-commands in the help message.
If either description or title(
Subparsers.title(String)
) is specified, sub-command help will be displayed in its own group.- Specified by:
description
in interfaceSubparsers
- Parameters:
description
- The text to display to briefly describe sub-commands- Returns:
- this
-
getDescription
-
metavar
Description copied from interface:Subparsers
Sets the text used to represent sub-commands in help messages.
By default, text to represent sub-commands are concatenation of all sub-commands. This method can override this default behavior and sets arbitrary string to use. This is useful if there are many sub-commands and you don't want to show them all.
- Specified by:
metavar
in interfaceSubparsers
- Parameters:
metavar
- The text used to represent sub-commands in help messages- Returns:
- this
-
hasSubCommand
public boolean hasSubCommand() -
parseArg
- Throws:
ArgumentParserException
-
formatShortSyntax
-
printSubparserHelp
Writes the help message for this and descendants.- Parameters:
writer
- The writer to outputformat_width
- column width
-
getCommands
Returns collection of the sub-command name under this object.- Returns:
- collection of the sub-comman name
-
addAlias
Adds Subparser alias names for given Subparser. For each SubparsersImpl instance, alias names and commands must be unique. If duplication is found,IllegalArgumentException
is thrown.- Parameters:
subparser
- Subparser to add alias namesalias
- alias name
-