net.sourceforge.argparse4j.internal

Class SubparserImpl

java.lang.Object

net.sourceforge.argparse4j.internal.SubparserImpl

All Implemented Interfaces:

ArgumentContainer, ArgumentParser, Subparser

public final class SubparserImpl
extends Object
implements Subparser, ArgumentParser

The application code must not use this class directly.

Method Summary

Modifier and Type	Method and Description
Argument	addArgument(String... nameOrFlags) Creates new Argument, adds it to this container and returns it.
ArgumentGroup	addArgumentGroup(String title) Creates new ArgumentGroup object and adds to this parser and returns the object.
MutuallyExclusiveGroup	addMutuallyExclusiveGroup() Creates new mutually exclusive group, MutuallyExclusiveGroup object, without title and adds to this parser and returns the object.
MutuallyExclusiveGroup	addMutuallyExclusiveGroup(String title) Creates new mutually exclusive group, MutuallyExclusiveGroup object, and adds to this parser and returns the object.
Subparsers	addSubparsers() Returns Subparsers.
SubparserImpl	aliases(String... alias) Sets alias names for this Subparser.
SubparserImpl	defaultHelp(boolean defaultHelp) If defaultHelp is true, the default values of arguments are printed in help message.
SubparserImpl	description(String description) Sets the description for the arguments of this container.
SubparserImpl	epilog(String epilog) Sets the text to display after the argument help.
String	formatHelp() Returns help message.
String	formatUsage() Returns a brief description of how the program should be invoked on the command line.
String	formatVersion() Returns version string.
String	getCommand()
ArgumentParserConfigurationImpl	getConfig() Get the configuration of this argument parser.
Object	getDefault(String dest) Returns default value of given dest.
void	handleError(ArgumentParserException e) Prints usage and error message.
void	handleError(ArgumentParserException e, PrintWriter writer) Prints usage and error message to the given writer.
SubparserImpl	help(FeatureControl ctrl) Sets special value to control help message handling.
SubparserImpl	help(String help) Sets the text to display in help message.
void	parseArgs(net.sourceforge.argparse4j.internal.ParseState state, Map<String,Object> opts)
Namespace	parseArgs(String[] args) Parses command line arguments.
void	parseArgs(String[] args, Map<String,Object> attrs) Parses command line arguments.
void	parseArgs(String[] args, Map<String,Object> attrs, Object userData) Parses command line arguments.
void	parseArgs(String[] args, Object userData) Parses command line arguments.
Namespace	parseArgsOrFail(String[] args) Parses command line arguments, handling any errors.
Namespace	parseKnownArgs(String[] args, List<String> unknown) Just like ArgumentParser.parseArgs(String[]), but parses only known arguments without throwing exception for unrecognized arguments.
void	parseKnownArgs(String[] args, List<String> unknown, Map<String,Object> attrs) Just like ArgumentParser.parseArgs(String[], Map), but parses only known arguments without throwing exception for unrecognized arguments.
void	parseKnownArgs(String[] args, List<String> unknown, Map<String,Object> attrs, Object userData) Just like ArgumentParser.parseArgs(String[], Map, Object), but parses only known arguments without throwing exception for unrecognized arguments.
void	parseKnownArgs(String[] args, List<String> unknown, Object userData) Just like ArgumentParser.parseArgs(String[], Object), but parses only known arguments without throwing exception for unrecognized arguments.
Namespace	parseKnownArgsOrFail(String[] args, List<String> unknown) Just like ArgumentParser.parseArgsOrFail(String[]), but parses only known arguments without throwing exception for unrecognized arguments.
void	printHelp() Prints help message in stdout.
void	printHelp(PrintWriter writer) Prints help message in writer.
void	printUsage() Print a brief description of how the program should be invoked on the command line in stdout.
void	printUsage(PrintWriter writer) Print a brief description of how the program should be invoked on the command line in writer.
void	printVersion() Prints version string in stdout.
void	printVersion(PrintWriter writer) Prints version string in writer.
SubparserImpl	setDefault(String dest, Object value) Sets parser-level default value of attribute dest.
SubparserImpl	setDefaults(Map<String,Object> attrs) Sets parser-level default values from attrs.
SubparserImpl	usage(String usage) Sets the text to display as usage line.
SubparserImpl	version(String version) Sets version string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addArgument

public Argument addArgument(String... nameOrFlags)

Description copied from interface: ArgumentContainer

Creates new Argument, adds it to this container and returns it.

The nameOrFlags is either a single name of positional argument or a list of option strings for named argument, e.g. foo or -f, --foo.

Specified by:

addArgument in interface ArgumentContainer

Parameters:

nameOrFlags - A name or a list of option strings of new Argument.

Returns:

Argument object.

addArgumentGroup

public ArgumentGroup addArgumentGroup(String title)

Description copied from interface: ArgumentParser

Creates new ArgumentGroup object and adds to this parser and returns the object.

The title is printed in help message as a title of this group. ArgumentGroup provides a way to conceptually group up command line arguments.

Specified by:

addArgumentGroup in interface ArgumentParser

Parameters:

title - The title printed in help message.

Returns:

ArgumentGroup object.

addMutuallyExclusiveGroup

public MutuallyExclusiveGroup addMutuallyExclusiveGroup()

Description copied from interface: ArgumentParser

Creates new mutually exclusive group, MutuallyExclusiveGroup object, without title and adds to this parser and returns the object.

Specified by:

addMutuallyExclusiveGroup in interface ArgumentParser

Returns:

MutuallyExclusiveGroup object.

addMutuallyExclusiveGroup

public MutuallyExclusiveGroup addMutuallyExclusiveGroup(String title)

Description copied from interface: ArgumentParser

Creates new mutually exclusive group, MutuallyExclusiveGroup object, and adds to this parser and returns the object.

The arguments added to this group are mutually exclusive; if more than one argument belong to the group are specified, an error will be reported. The title is printed in help message as a title of this group.

Specified by:

addMutuallyExclusiveGroup in interface ArgumentParser

Parameters:

title - The title printed in help message.

Returns:

The MutuallyExclusiveGroup object.

addSubparsers

public Subparsers addSubparsers()

Description copied from interface: ArgumentParser

Returns Subparsers.

The method name is rather controversial because repeated call of this method does not add new Subparsers object. Instead, this method always returns same Subparsers object. Subparsers object provides a way to add sub-commands.

Specified by:

addSubparsers in interface ArgumentParser

Returns:

Subparsers object.

usage

public SubparserImpl usage(String usage)

Description copied from interface: ArgumentParser

Sets the text to display as usage line. By default, the usage line is calculated from the arguments this object contains.

If the given usage contains ${prog} string, it will be replaced with the program name given in ArgumentParsers.newArgumentParser(String).

Specified by:

usage in interface ArgumentParser

Parameters:

usage - usage text

Returns:

this

description

public SubparserImpl description(String description)

Description copied from interface: ArgumentContainer

Sets the description for the arguments of this container.

Specified by:

description in interface ArgumentContainer

Specified by:

description in interface ArgumentParser

Specified by:

description in interface Subparser

Parameters:

description - The description of this container.

Returns:

this

epilog

public SubparserImpl epilog(String epilog)

Description copied from interface: ArgumentParser

Sets the text to display after the argument help.

Specified by:

epilog in interface ArgumentParser

Specified by:

epilog in interface Subparser

Parameters:

epilog - The text to display after the argument help.

Returns:

this

version

public SubparserImpl version(String version)

Description copied from interface: 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.

Specified by:

version in interface ArgumentParser

Specified by:

version in interface Subparser

Parameters:

version - The version string.

Returns:

this

defaultHelp

public SubparserImpl defaultHelp(boolean defaultHelp)

Description copied from interface: 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.

Specified by:

defaultHelp in interface ArgumentParser

Specified by:

defaultHelp in interface Subparser

Parameters:

defaultHelp - Switch to display the default value in help message.

Returns:

this

printHelp

public void printHelp()

Description copied from interface: ArgumentParser

Prints help message in stdout.

Specified by:

printHelp in interface ArgumentParser

printHelp

public void printHelp(PrintWriter writer)

Description copied from interface: ArgumentParser

Prints help message in writer.

Specified by:

printHelp in interface ArgumentParser

Parameters:

writer - Writer to print message.

formatHelp

public String formatHelp()

Description copied from interface: ArgumentParser

Returns help message.

Specified by:

formatHelp in interface ArgumentParser

Returns:

The help message.

printUsage

public void printUsage()

Description copied from interface: ArgumentParser

Print a brief description of how the program should be invoked on the command line in stdout.

Specified by:

printUsage in interface ArgumentParser

printUsage

public void printUsage(PrintWriter writer)

Description copied from interface: ArgumentParser

Print a brief description of how the program should be invoked on the command line in writer.

Specified by:

printUsage in interface ArgumentParser

Parameters:

writer - Writer to print message.

formatUsage

public String formatUsage()

Description copied from interface: ArgumentParser

Returns a brief description of how the program should be invoked on the command line.

Specified by:

formatUsage in interface ArgumentParser

Returns:

Usage text.

printVersion

public void printVersion()

Description copied from interface: ArgumentParser

Prints version string in stdout.

Specified by:

printVersion in interface ArgumentParser

printVersion

public void printVersion(PrintWriter writer)

Description copied from interface: ArgumentParser

Prints version string in writer.

Specified by:

printVersion in interface ArgumentParser

Parameters:

writer - Writer to print version string.

formatVersion

public String formatVersion()

Description copied from interface: ArgumentParser

Returns version string.

Specified by:

formatVersion in interface ArgumentParser

Returns:

The version string.

setDefault

public SubparserImpl setDefault(String dest,
                                Object value)

Description copied from interface: ArgumentParser

Sets parser-level default value of attribute dest.

The parser-level defaults always override argument-level defaults.

Specified by:

setDefault in interface ArgumentParser

Specified by:

setDefault in interface Subparser

Parameters:

dest - The attribute name.

value - The default value.

Returns:

this

setDefaults

public SubparserImpl setDefaults(Map<String,Object> attrs)

Description copied from interface: 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.

Specified by:

setDefaults in interface ArgumentParser

Specified by:

setDefaults in interface Subparser

Parameters:

attrs - The parser-level default values to add.

Returns:

this

getDefault

public Object getDefault(String dest)

Description copied from interface: ArgumentParser

Returns default value of given dest.

Returns default value set by Argument.setDefault(Object), ArgumentParser.setDefault(String, Object) or ArgumentParser.setDefaults(Map). Please note that while parser-level defaults always override argument-level defaults while parsing, this method examines argument-level defaults first. If no default value is found, then check parser-level defaults. If no default value is found, returns null.

Specified by:

getDefault in interface ArgumentParser

Parameters:

dest - The attribute name of default value to get.

Returns:

The default value of given dest.

help

public SubparserImpl help(String help)

Description copied from interface: Subparser

Sets the text to display in help message.

Specified by:

help in interface Subparser

Parameters:

help - The text to display in help message.

Returns:

this

help

public SubparserImpl help(FeatureControl ctrl)

Description copied from interface: Subparser

Sets special value to control help message handling.

Currently, only FeatureControl.SUPPRESS is available. If it is given, the help entry for this Subparser is not displayed in the help message.

Specified by:

help in interface Subparser

Parameters:

ctrl - The special value to control help message handling.

Returns:

this

parseArgsOrFail

public Namespace parseArgsOrFail(String[] args)

Description copied from interface: ArgumentParser

Parses command line arguments, handling any errors.

This is a shortcut method that combines ArgumentParser.parseArgs(java.lang.String[]) and ArgumentParser.handleError(net.sourceforge.argparse4j.inf.ArgumentParserException). If the arguments can be successfully parsed, the resulted attributes are returned as a Namespace object. Otherwise, the program exits with a 1 return code.

Specified by:

parseArgsOrFail in interface ArgumentParser

Parameters:

args - Command line arguments.

Returns:

Namespace object.

parseArgs

public Namespace parseArgs(String[] args)
                    throws ArgumentParserException

Description copied from interface: ArgumentParser

Parses command line arguments.

The resulted attributes are returned as Namespace object. This method must not alter the status of this parser and can be called multiple times.

Specified by:

parseArgs in interface ArgumentParser

Parameters:

args - Command line arguments.

Returns:

Namespace object.

Throws:

ArgumentParserException - If an error occurred.

parseArgs

public void parseArgs(String[] args,
                      Map<String,Object> attrs)
               throws ArgumentParserException

Description copied from interface: ArgumentParser

Parses command line arguments.

Unlike ArgumentParser.parseArgs(String[]), which returns Namespace object, this method stores attributes in given attrs.

Specified by:

parseArgs in interface ArgumentParser

Parameters:

args - Command line arguments.

attrs - Map object to store attributes.

Throws:

ArgumentParserException - If an error occurred.

parseArgs

public void parseArgs(String[] args,
                      Object userData)
               throws ArgumentParserException

Description copied from interface: ArgumentParser

Parses command line arguments.

Unlike ArgumentParser.parseArgs(String[]), which returns Namespace object, this method stores attributes in given userData. The location to store value is designated using Arg annotations. User don't have to specify Arg for all attributes: the missing attributes are just skipped. This method performs simple List to generic array conversion. For example, user can assign List<Integer> attribute to generic array int[].

Specified by:

parseArgs in interface ArgumentParser

Parameters:

args - Command line arguments.

userData - Object to store attributes.

Throws:

ArgumentParserException - If an error occurred.

parseArgs

public void parseArgs(String[] args,
                      Map<String,Object> attrs,
                      Object userData)
               throws ArgumentParserException

Description copied from interface: ArgumentParser

Parses command line arguments.

This is a combination of ArgumentParser.parseArgs(String[], Map) and ArgumentParser.parseArgs(String[], Object). The all attributes will be stored in attrs. The attributes specified in Arg annotations will be also stored in userData.

Specified by:

parseArgs in interface ArgumentParser

Parameters:

args - Command line arguments.

attrs - Map to store attributes.

userData - Object to store attributes.

Throws:

ArgumentParserException - If an error occurred.

parseKnownArgsOrFail

public Namespace parseKnownArgsOrFail(String[] args,
                                      List<String> unknown)

Description copied from interface: ArgumentParser

Just like ArgumentParser.parseArgsOrFail(String[]), but parses only known arguments without throwing exception for unrecognized arguments. If unknown is not null, unrecognized arguments will be stored in it.

Specified by:

parseKnownArgsOrFail in interface ArgumentParser

Parameters:

args - Command line arguments.

unknown - Output variable to store unrecognized arguments, or null

Returns:

Namespace object.

parseKnownArgs

public Namespace parseKnownArgs(String[] args,
                                List<String> unknown)
                         throws ArgumentParserException

Description copied from interface: ArgumentParser

Just like ArgumentParser.parseArgs(String[]), but parses only known arguments without throwing exception for unrecognized arguments. If unknown is not null, unrecognized arguments will be stored in it.

Specified by:

parseKnownArgs in interface ArgumentParser

Parameters:

args - Command line arguments.

unknown - Output variable to store unrecognized arguments, or null

Returns:

Namespace object.

Throws:

ArgumentParserException - If an error occurred.

parseKnownArgs

public void parseKnownArgs(String[] args,
                           List<String> unknown,
                           Map<String,Object> attrs)
                    throws ArgumentParserException

Description copied from interface: ArgumentParser

Just like ArgumentParser.parseArgs(String[], Map), but parses only known arguments without throwing exception for unrecognized arguments. If unknown is not null, unrecognized arguments will be stored in it.

Specified by:

parseKnownArgs in interface ArgumentParser

Parameters:

args - Command line arguments.

unknown - Output variable to store unrecognized arguments, or null

attrs - Map object to store attributes.

Throws:

ArgumentParserException - If an error occurred.

parseKnownArgs

public void parseKnownArgs(String[] args,
                           List<String> unknown,
                           Object userData)
                    throws ArgumentParserException

Description copied from interface: ArgumentParser

Just like ArgumentParser.parseArgs(String[], Object), but parses only known arguments without throwing exception for unrecognized arguments. If unknown is not null, unrecognized arguments will be stored in it.

Specified by:

parseKnownArgs in interface ArgumentParser

Parameters:

args - Command line arguments.

unknown - Output variable to store unrecognized arguments, or null

userData - Object to store attributes.

Throws:

ArgumentParserException - If an error occurred.

parseKnownArgs

public void parseKnownArgs(String[] args,
                           List<String> unknown,
                           Map<String,Object> attrs,
                           Object userData)
                    throws ArgumentParserException

Description copied from interface: ArgumentParser

Just like ArgumentParser.parseArgs(String[], Map, Object), but parses only known arguments without throwing exception for unrecognized arguments. If unknown is not null, unrecognized arguments will be stored in it.

Specified by:

parseKnownArgs in interface ArgumentParser

Parameters:

args - Command line arguments.

unknown - Output variable to store unrecognized arguments, or null

attrs - Map to store attributes.

userData - Object to store attributes.

Throws:

ArgumentParserException - If an error occurred.

handleError

public void handleError(ArgumentParserException e)

Description copied from interface: ArgumentParser

Prints usage and error message.

Please note that this method does not terminate the program.

Specified by:

handleError in interface ArgumentParser

Parameters:

e - Error thrown by ArgumentParser.parseArgs(String[]).

handleError

public void handleError(ArgumentParserException e,
                        PrintWriter writer)

Description copied from interface: ArgumentParser

Prints usage and error message to the given writer.

Please note that this method does not terminate the program.

Specified by:

handleError in interface ArgumentParser

Parameters:

e - Error thrown by ArgumentParser.parseArgs(String[]).

aliases

public SubparserImpl aliases(String... alias)

Description copied from interface: Subparser

Sets alias names for this Subparser. The alias names must be unique for each Subparsers instance which this object belongs to.

Specified by:

aliases in interface Subparser

Parameters:

alias - Alias name for this Subparser.

Returns:

this

parseArgs

public void parseArgs(net.sourceforge.argparse4j.internal.ParseState state,
                      Map<String,Object> opts)
               throws ArgumentParserException

Throws:

ArgumentParserException

getCommand

public String getCommand()

getConfig

public ArgumentParserConfigurationImpl getConfig()

Description copied from interface: ArgumentParser

Get the configuration of this argument parser.

Specified by:

getConfig in interface ArgumentParser

Returns:

The argument parser configuration.