net.sourceforge.argparse4j.inf

Interface Subparsers

All Known Implementing Classes:

SubparsersImpl

public interface Subparsers

This interface defines Subparsers which used to add Subparser.

Subparser is used to add sub-command to ArgumentParser.

Method Summary

Modifier and Type	Method and Description
Subparser	addParser(String command) Adds and returns Subparser object with given sub-command name.
Subparser	addParser(String command, boolean addHelp) Adds and returns Subparser object with given sub-command name and addHelp.
Subparser	addParser(String command, boolean addHelp, String prefixChars) Adds and returns Subparser object with given sub-command name, addHelp and prefixChars.
Subparsers	description(String description) Sets the text to display to briefly describe sub-commands in the help message.
Subparsers	dest(String dest) Sets the name of attribute which the selected command name is stored.
Subparsers	help(String help) Sets the text to display in the help message for sub-commands.
Subparsers	metavar(String metavar) Sets the text used to represent sub-commands in help messages.
Subparsers	title(String title) Sets the text to display as a title of sub-commands in the help message.

Method Detail

addParser

Subparser addParser(String command)

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.

Parameters:

command - Sub-command name

Returns:

Subparser object.

addParser

Subparser addParser(String command,
                    boolean addHelp)

Adds and returns Subparser object with given sub-command name and addHelp. The given command must be unique for each Subparsers instance.

For addHelp, see ArgumentParsers.newArgumentParser(String, boolean, String). The prefixChars is inherited from main ArgumentParser.

Parameters:

command - Sub-command name

addHelp - If true, -h/--help are available. If false, they are not.

Returns:

Subparser object

addParser

Subparser addParser(String command,
                    boolean addHelp,
                    String prefixChars)

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, see ArgumentParsers.newArgumentParser(String, boolean, String).

Parameters:

command - Sub-command name

addHelp - If true, -h/--help are available. If false, they are not.

prefixChars - The set of characters that prefix named arguments.

Returns:

Subparser object

dest

Subparsers dest(String dest)

Sets the name of attribute which the selected command name is stored.

Parameters:

dest - The name of attribute the selected command name is stored.

Returns:

this.

help

Subparsers help(String help)

Sets the text to display in the help message for sub-commands.

Parameters:

help - The text to display in the help message.

Returns:

this

title

Subparsers title(String title)

Sets the text to display as a title of sub-commands in the help message.

If either title or description(description(String)) is specified, sub-command help will be displayed in its own group.

Parameters:

title - The text to display as a title of sub-commands

Returns:

this

description

Subparsers description(String description)

Sets the text to display to briefly describe sub-commands in the help message.

If either description or title(title(String)) is specified, sub-command help will be displayed in its own group.

Parameters:

description - The text to display to briefly describe sub-commands

Returns:

this

metavar

Subparsers metavar(String metavar)

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.

Parameters:

metavar - The text used to represent sub-commands in help messages

Returns:

this