Interface ArgumentParser
- All Known Subinterfaces:
Subparser
- All Known Implementing Classes:
ArgumentParserImpl
,SubparserImpl
This interface defines behavior of ArgumentParser.
The typical usage is set description using description(String)
and
add arguments using addArgument(String...)
. To add sub-command,
first call addSubparsers()
to obtain Subparsers
object.
Subparsers
object provides necessary methods to add sub-commands. To
make a conceptual group of arguments, first call
addArgumentGroup(String)
to create ArgumentGroup
object. And
add argument to that group using ArgumentGroup.addArgument(String...)
. Similarly, to add the mutually exclusive group of arguments, use
addMutuallyExclusiveGroup(String)
to create
MutuallyExclusiveGroup
object. To parse command-line arguments, call
parseArgs(String[])
or several overloaded methods.
-
Method Summary
Modifier and TypeMethodDescriptionaddArgument
(String... nameOrFlags) Creates newArgument
object and adds to this parser and returns the object.addArgumentGroup
(String title) Creates newArgumentGroup
object and adds to this parser and returns the object.Creates new mutually exclusive group,MutuallyExclusiveGroup
object, without title and adds to this parser and returns the object.addMutuallyExclusiveGroup
(String title) Creates new mutually exclusive group,MutuallyExclusiveGroup
object, and adds to this parser and returns the object.ReturnsSubparsers
.defaultHelp
(boolean defaultHelp) If defaultHelp istrue
, the default values of arguments are printed in help message.description
(String description) Sets the text to display before the argument help.Sets the text to display after the argument help.Returns help message.Returns a brief description of how the program should be invoked on the command line.Returns version string.getDefault
(String dest) Returns default value of givendest
.void
Prints usage and error message.Parses command line arguments.void
Parses command line arguments.void
Parses command line arguments.void
Parses command line arguments.parseArgsOrFail
(String[] args) Parses command line arguments, handling any errors.void
Prints help message in stdout.void
printHelp
(PrintWriter writer) Prints help message in writer.void
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
Prints version string in stdout.void
printVersion
(PrintWriter writer) Prints version string in writer.setDefault
(String dest, Object value) Sets parser-level default value of attributedest
.setDefaults
(Map<String, Object> attrs) Sets parser-level default values fromattrs
.Sets the text to display as usage line.Sets version string.
-
Method Details
-
addArgument
Creates new
Argument
object and adds to this parser and returns the object.The
nameOrFlags
is either a single name of positional argument or a list of option strings for optional argument, e.g.foo
or-f, --foo
. -
addArgumentGroup
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.- Parameters:
title
- The title printed in help message.- Returns:
ArgumentGroup
object.
-
addMutuallyExclusiveGroup
MutuallyExclusiveGroup addMutuallyExclusiveGroup()Creates new mutually exclusive group,
MutuallyExclusiveGroup
object, without title and adds to this parser and returns the object.- Returns:
MutuallyExclusiveGroup
object.
-
addMutuallyExclusiveGroup
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.- Parameters:
title
- The title printed in help message.- Returns:
- The
MutuallyExclusiveGroup
object.
-
addSubparsers
Subparsers addSubparsers()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 sameSubparsers
object.Subparsers
object provides a way to add sub-commands.- Returns:
Subparsers
object.
-
usage
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)
.- Parameters:
usage
- usage text- Returns:
- this
-
description
Sets the text to display before the argument help.- Parameters:
description
- The text to display before the argument help.- Returns:
- this
-
epilog
Sets the text to display after the argument help.- Parameters:
epilog
- The text to display after the argument help.- Returns:
- this
-
version
Sets version string. It will be displayed
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.- Parameters:
version
- The version string.- Returns:
- this
-
defaultHelp
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.
- Parameters:
defaultHelp
- Switch to display the default value in help message.- Returns:
- this
-
printHelp
void printHelp()Prints help message in stdout. -
printHelp
Prints help message in writer.- Parameters:
writer
- Writer to print message.
-
formatHelp
String formatHelp()Returns help message.- Returns:
- The help message.
-
printUsage
void printUsage()Print a brief description of how the program should be invoked on the command line in stdout. -
printUsage
Print a brief description of how the program should be invoked on the command line in writer.- Parameters:
writer
- Writer to print message.
-
formatUsage
String formatUsage()Returns a brief description of how the program should be invoked on the command line.- Returns:
- Usage text.
-
printVersion
void printVersion()Prints version string in stdout. -
printVersion
Prints version string in writer.- Parameters:
writer
- Writer to print version string.
-
formatVersion
String formatVersion()Returns version string.- Returns:
- The version string.
-
setDefault
Sets parser-level default value of attribute
dest
.The parser-level defaults always override argument-level defaults.
- Parameters:
dest
- The attribute name.value
- The default value.- Returns:
- this
-
setDefaults
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.- Parameters:
attrs
- The parser-level default values to add.- Returns:
- this
-
getDefault
Returns default value of given
dest
.Returns default value set by
Argument.setDefault(Object)
,setDefault(String, Object)
orsetDefaults(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, returnsnull
.- Parameters:
dest
- The attribute name of default value to get.- Returns:
- The default value of given dest.
-
parseArgsOrFail
Parses command line arguments, handling any errors.
This is a shortcut method that combines
parseArgs(java.lang.String[])
andhandleError(net.sourceforge.argparse4j.inf.ArgumentParserException)
. If the arguments can be successfully parsed, the resulted attributes are returned as aNamespace
object. Otherwise, the program exits with a1
return code.- Parameters:
args
- Command line arguments.- Returns:
Namespace
object.
-
parseArgs
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.- Parameters:
args
- Command line arguments.- Returns:
Namespace
object.- Throws:
ArgumentParserException
- If an error occurred.
-
parseArgs
Parses command line arguments.
Unlike
parseArgs(String[])
, which returnsNamespace
object, this method stores attributes in givenattrs
.- Parameters:
args
- Command line arguments.attrs
- Map object to store attributes.- Throws:
ArgumentParserException
- If an error occurred.
-
parseArgs
Parses command line arguments.
Unlike
parseArgs(String[])
, which returnsNamespace
object, this method stores attributes in givenuserData
. The location to store value is designated usingArg
annotations. User don't have to specifyArg
for all attributes: the missing attributes are just skipped. This method performs simpleList
to generic array conversion. For example, user can assignList<Integer>
attribute to generic arrayint[]
.- Parameters:
args
- Command line arguments.userData
- Object to store attributes.- Throws:
ArgumentParserException
- If an error occurred.
-
parseArgs
void parseArgs(String[] args, Map<String, Object> attrs, Object userData) throws ArgumentParserExceptionParses command line arguments.
This is a combination of
parseArgs(String[], Map)
andparseArgs(String[], Object)
. The all attributes will be stored inattrs
. The attributes specified inArg
annotations will be also stored inuserData
.- Parameters:
args
- Command line arguments.attrs
- Map to store attributes.userData
- Object to store attributes.- Throws:
ArgumentParserException
- If an error occurred.
-
handleError
Prints usage and error message.
Please note that this method does not terminate the program.
- Parameters:
e
- Error thrown byparseArgs(String[])
.
-