public static class CommandLine.ParseResult
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
CommandLine.ParseResult.Builder
Builds immutable
ParseResult instances. |
Modifier and Type | Method and Description |
---|---|
java.util.List<CommandLine> |
asCommandLineList()
Returns this
ParseResult as a list of CommandLine objects, one for each matched command/subcommand. |
static CommandLine.ParseResult.Builder |
builder(CommandLine.Model.CommandSpec commandSpec)
Creates and returns a new
ParseResult.Builder for the specified command spec. |
CommandLine.Model.CommandSpec |
commandSpec()
Returns the
CommandSpec for the matched command. |
java.util.List<java.lang.Exception> |
errors()
If
CommandLine.Model.ParserSpec.collectErrors is true , returns the list of exceptions that were encountered during parsing, otherwise, returns an empty list. |
boolean |
hasMatchedOption(char shortName)
Returns whether an option whose aliases include the specified short name was matched on the command line.
|
boolean |
hasMatchedOption(CommandLine.Model.OptionSpec option)
Returns whether the specified option was matched on the command line.
|
boolean |
hasMatchedOption(java.lang.String name)
Returns whether an option whose aliases include the specified name was matched on the command line.
|
boolean |
hasMatchedPositional(CommandLine.Model.PositionalParamSpec positional)
Returns whether the specified positional parameter was matched on the command line.
|
boolean |
hasMatchedPositional(int position)
Returns whether a positional parameter was matched at the specified position.
|
boolean |
hasSubcommand()
Returns
true if a subcommand was matched on the command line, false otherwise. |
boolean |
isUsageHelpRequested()
Returns
true if one of the options that was matched on the command line is a usageHelp option. |
boolean |
isVersionHelpRequested()
Returns
true if one of the options that was matched on the command line is a versionHelp option. |
CommandLine.Model.OptionSpec |
matchedOption(char shortName)
Returns the option with the specified short name, or
null if no option with that name was matched
on the command line. |
CommandLine.Model.OptionSpec |
matchedOption(java.lang.String name)
Returns the option with the specified name, or
null if no option with that name was matched on the command line. |
java.util.List<CommandLine.Model.OptionSpec> |
matchedOptions()
Returns a list of matched options, in the order they were found on the command line.
|
<T> T |
matchedOptionValue(char shortName,
T defaultValue)
Returns the command line argument value of the option with the specified name, converted to the type of the option, or the specified default value if no option with the specified name was matched.
|
<T> T |
matchedOptionValue(java.lang.String name,
T defaultValue)
Returns the command line argument value of the option with the specified name, converted to the type of the option, or the specified default value if no option with the specified name was matched.
|
CommandLine.Model.PositionalParamSpec |
matchedPositional(int position)
Returns the first
PositionalParamSpec that matched an argument at the specified position, or null if no positional parameters were matched at that position. |
java.util.List<CommandLine.Model.PositionalParamSpec> |
matchedPositionals()
Returns a list of matched positional parameters.
|
java.util.List<CommandLine.Model.PositionalParamSpec> |
matchedPositionals(int position)
Returns all
PositionalParamSpec objects that matched an argument at the specified position, or an empty list if no positional parameters were matched at that position. |
<T> T |
matchedPositionalValue(int position,
T defaultValue)
Returns the command line argument value of the positional parameter at the specified position, converted to the type of the positional parameter, or the specified default value if no positional parameter was matched at that position.
|
java.util.List<java.lang.String> |
originalArgs()
Returns the command line arguments that were parsed.
|
CommandLine.ParseResult |
subcommand()
Returns the
ParseResult for the subcommand of this command that was matched on the command line, or null if no subcommand was matched. |
java.util.List<java.lang.String> |
unmatched()
Returns a list of command line arguments that did not match any options or positional parameters.
|
public static CommandLine.ParseResult.Builder builder(CommandLine.Model.CommandSpec commandSpec)
ParseResult.Builder
for the specified command spec.public CommandLine.Model.OptionSpec matchedOption(char shortName)
null
if no option with that name was matched
on the command line.
Use getValue
on the returned OptionSpec
to get the matched value (or values),
converted to the type of the option. Alternatively, use stringValues
to get the matched String values after they were split into parts, or
originalStringValues
to get the original String values that were
matched on the command line, before any processing.
To get the default value of an option that was
not matched on the command line, use
parseResult.commandSpec().findOption(shortName).getValue()
.
public CommandLine.Model.OptionSpec matchedOption(java.lang.String name)
null
if no option with that name was matched on the command line.
Use getValue
on the returned OptionSpec
to get the matched value (or values),
converted to the type of the option. Alternatively, use stringValues
to get the matched String values after they were split into parts, or
originalStringValues
to get the original String values that were
matched on the command line, before any processing.
To get the default value of an option that was
not matched on the command line, use
parseResult.commandSpec().findOption(String).getValue()
.
name
- used to search the matched options. May be an alias of the option name that was actually specified on the command line.
The specified name may include option name prefix characters or not.CommandLine.Model.CommandSpec.findOption(String)
public CommandLine.Model.PositionalParamSpec matchedPositional(int position)
PositionalParamSpec
that matched an argument at the specified position, or null
if no positional parameters were matched at that position.public java.util.List<CommandLine.Model.PositionalParamSpec> matchedPositionals(int position)
PositionalParamSpec
objects that matched an argument at the specified position, or an empty list if no positional parameters were matched at that position.public CommandLine.Model.CommandSpec commandSpec()
CommandSpec
for the matched command.public boolean hasMatchedOption(char shortName)
shortName
- used to search the matched options. May be an alias of the option name that was actually specified on the command line.public boolean hasMatchedOption(java.lang.String name)
name
- used to search the matched options. May be an alias of the option name that was actually specified on the command line.
The specified name may include option name prefix characters or not.public boolean hasMatchedOption(CommandLine.Model.OptionSpec option)
public boolean hasMatchedPositional(int position)
public boolean hasMatchedPositional(CommandLine.Model.PositionalParamSpec positional)
public java.util.List<CommandLine.Model.OptionSpec> matchedOptions()
public java.util.List<CommandLine.Model.PositionalParamSpec> matchedPositionals()
public java.util.List<java.lang.String> unmatched()
public java.util.List<java.lang.String> originalArgs()
public java.util.List<java.lang.Exception> errors()
CommandLine.Model.ParserSpec.collectErrors
is true
, returns the list of exceptions that were encountered during parsing, otherwise, returns an empty list.public <T> T matchedOptionValue(char shortName, T defaultValue)
public <T> T matchedOptionValue(java.lang.String name, T defaultValue)
public <T> T matchedPositionalValue(int position, T defaultValue)
public boolean hasSubcommand()
true
if a subcommand was matched on the command line, false
otherwise.public CommandLine.ParseResult subcommand()
ParseResult
for the subcommand of this command that was matched on the command line, or null
if no subcommand was matched.public boolean isUsageHelpRequested()
true
if one of the options that was matched on the command line is a usageHelp
option.public boolean isVersionHelpRequested()
true
if one of the options that was matched on the command line is a versionHelp
option.public java.util.List<CommandLine> asCommandLineList()
ParseResult
as a list of CommandLine
objects, one for each matched command/subcommand.
For backwards compatibility with pre-3.0 methods.