- java.lang.Object
-
- picocli.CommandLine.ParseResult.Builder
-
- Enclosing class:
- CommandLine.ParseResult
public static class CommandLine.ParseResult.Builder extends Object
Builds immutableParseResult
instances.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CommandLine.ParseResult.Builder
add(CommandLine.Model.ArgSpec arg, int position)
Adds the specifiedOptionSpec
orPositionalParamSpec
to the list of options and parameters that were matched on the command line.void
addError(CommandLine.PicocliException ex)
CommandLine.ParseResult.Builder
addOption(CommandLine.Model.OptionSpec option)
Adds the specifiedOptionSpec
to the list of options that were matched on the command line.CommandLine.ParseResult.Builder
addPositionalParam(CommandLine.Model.PositionalParamSpec positionalParam, int position)
Adds the specifiedPositionalParamSpec
to the list of parameters that were matched on the command line.CommandLine.ParseResult.Builder
addUnmatched(String arg)
Adds the specified command line argument to the list of unmatched command line arguments.CommandLine.ParseResult.Builder
addUnmatched(Stack<String> args)
Adds all elements of the specified command line arguments stack to the list of unmatched command line arguments.CommandLine.ParseResult
build()
Creates and returns a newParseResult
instance for this builder's configuration.CommandLine.ParseResult.Builder
expandedArgs(Collection<String> expandedArgs)
Sets the specified command line arguments after @-files were expanded; these are the arguments that were actually parsed.CommandLine.ParseResult.Builder
originalArgs(String[] originalArgs)
Sets the specified original command line arguments that were passed to theCommandLine.parseArgs(String...)
method, before @-file expansion.CommandLine.ParseResult.Builder
subcommand(CommandLine.ParseResult subcommand)
Sets the specifiedParseResult
for a subcommand that was matched on the command line.
-
-
-
Method Detail
-
build
public CommandLine.ParseResult build()
Creates and returns a newParseResult
instance for this builder's configuration.
-
add
public CommandLine.ParseResult.Builder add(CommandLine.Model.ArgSpec arg, int position)
Adds the specifiedOptionSpec
orPositionalParamSpec
to the list of options and parameters that were matched on the command line.- Parameters:
arg
- the matchedOptionSpec
orPositionalParamSpec
position
- the command line position at which thePositionalParamSpec
was matched. Ignored forOptionSpec
s.- Returns:
- this builder for method chaining
-
addOption
public CommandLine.ParseResult.Builder addOption(CommandLine.Model.OptionSpec option)
Adds the specifiedOptionSpec
to the list of options that were matched on the command line.
-
addPositionalParam
public CommandLine.ParseResult.Builder addPositionalParam(CommandLine.Model.PositionalParamSpec positionalParam, int position)
Adds the specifiedPositionalParamSpec
to the list of parameters that were matched on the command line.- Parameters:
positionalParam
- the matchedPositionalParamSpec
position
- the command line position at which thePositionalParamSpec
was matched.- Returns:
- this builder for method chaining
-
addUnmatched
public CommandLine.ParseResult.Builder addUnmatched(String arg)
Adds the specified command line argument to the list of unmatched command line arguments.
-
addUnmatched
public CommandLine.ParseResult.Builder addUnmatched(Stack<String> args)
Adds all elements of the specified command line arguments stack to the list of unmatched command line arguments.
-
subcommand
public CommandLine.ParseResult.Builder subcommand(CommandLine.ParseResult subcommand)
Sets the specifiedParseResult
for a subcommand that was matched on the command line.
-
originalArgs
public CommandLine.ParseResult.Builder originalArgs(String[] originalArgs)
Sets the specified original command line arguments that were passed to theCommandLine.parseArgs(String...)
method, before @-file expansion.
-
expandedArgs
public CommandLine.ParseResult.Builder expandedArgs(Collection<String> expandedArgs)
Sets the specified command line arguments after @-files were expanded; these are the arguments that were actually parsed.- Since:
- 4.4
- See Also:
originalArgs(String[])
,CommandLine.ParseResult.expandedArgs()
-
addError
public void addError(CommandLine.PicocliException ex)
-
-