Package picocli

Class CommandLine.ParseResult.Builder

java.lang.Object

picocli.CommandLine.ParseResult.Builder

Enclosing class:

CommandLine.ParseResult

public static class CommandLine.ParseResult.Builder
extends Object

Builds immutable ParseResult instances.

Field Summary

Fields

Modifier and Type	Field	Description
private final CommandLine.Model.CommandSpec	commandSpec
private final List<Exception>	errors
private final List<String>	expandedArgList
private int	firstUnmatchedPosition
private final CommandLine.ParseResult.GroupMatchContainer	groupMatchContainer
(package private) boolean	isInitializingDefaultValues
private final List<CommandLine.Model.ArgSpec>	matchedArgsList
private final List<CommandLine.Model.OptionSpec>	matchedOptionsList
private final List<CommandLine.Model.PositionalParamSpec>	matchedPositionalsList
private List<Object>	nowProcessing
private final Set<CommandLine.Model.OptionSpec>	options
private final List<String>	originalArgList
private final List<List<CommandLine.Model.PositionalParamSpec>>	positionalParams
private final Set<CommandLine.Model.PositionalParamSpec>	positionals
private final List<CommandLine.ParseResult>	subcommands
private final List<String>	unmatched
private boolean	usageHelpRequested
private boolean	versionHelpRequested

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder(CommandLine.Model.CommandSpec spec)

Method Summary

Modifier and Type	Method	Description
CommandLine.ParseResult.Builder	add(CommandLine.Model.ArgSpec arg, int position)	Adds the specified OptionSpec or PositionalParamSpec 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 specified OptionSpec to the list of options that were matched on the command line.
(package private) void	addOriginalStringValue(CommandLine.Model.ArgSpec argSpec, String value)
CommandLine.ParseResult.Builder	addPositionalParam(CommandLine.Model.PositionalParamSpec positionalParam, int position)	Adds the specified PositionalParamSpec to the list of parameters that were matched on the command line.
(package private) void	addStringValue(CommandLine.Model.ArgSpec argSpec, String value)
(package private) void	addTypedValues(CommandLine.Model.ArgSpec argSpec, int position, Object typedValue)
private CommandLine.ParseResult.Builder	addUnmatched(int position, String arg)	Adds the specified command line argument to the list of unmatched command line arguments, and remembers the position of this argument.
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.
(package private) void	beforeMatchingGroupElement(CommandLine.Model.ArgSpec argSpec)
CommandLine.ParseResult	build()	Creates and returns a new ParseResult 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.
private void	nowProcessing(CommandLine.Model.ArgSpec spec, Object value)
CommandLine.ParseResult.Builder	originalArgs(String[] originalArgs)	Sets the specified original command line arguments that were passed to the CommandLine.parseArgs(String...) method, before @-file expansion.
CommandLine.ParseResult.Builder	subcommand(CommandLine.ParseResult subcommand)	Sets the specified ParseResult for a subcommand that was matched on the command line.
private int	totalArgCount()

Methods inherited from class java.lang.Object

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

Field Details

commandSpec

private final CommandLine.Model.CommandSpec commandSpec

matchedArgsList

private final List<CommandLine.Model.ArgSpec> matchedArgsList

matchedOptionsList

private final List<CommandLine.Model.OptionSpec> matchedOptionsList

matchedPositionalsList

private final List<CommandLine.Model.PositionalParamSpec> matchedPositionalsList

options

private final Set<CommandLine.Model.OptionSpec> options

positionals

private final Set<CommandLine.Model.PositionalParamSpec> positionals

unmatched

private final List<String> unmatched

firstUnmatchedPosition

private int firstUnmatchedPosition

originalArgList

private final List<String> originalArgList

expandedArgList

private final List<String> expandedArgList

positionalParams

private final List<List<CommandLine.Model.PositionalParamSpec>> positionalParams

subcommands

private final List<CommandLine.ParseResult> subcommands

usageHelpRequested

private boolean usageHelpRequested

versionHelpRequested

private boolean versionHelpRequested

isInitializingDefaultValues

boolean isInitializingDefaultValues

errors

private final List<Exception> errors

nowProcessing

private List<Object> nowProcessing

groupMatchContainer

private final CommandLine.ParseResult.GroupMatchContainer groupMatchContainer

Constructor Details

Builder

private Builder(CommandLine.Model.CommandSpec spec)

Method Details

build

public CommandLine.ParseResult build()

Creates and returns a new ParseResult instance for this builder's configuration.

nowProcessing

private void nowProcessing(CommandLine.Model.ArgSpec spec,
 Object value)

add

public CommandLine.ParseResult.Builder add(CommandLine.Model.ArgSpec arg,
 int position)

Adds the specified OptionSpec or PositionalParamSpec to the list of options and parameters that were matched on the command line.

Parameters:

arg - the matched OptionSpec or PositionalParamSpec

position - the command line position at which the PositionalParamSpec was matched. Ignored for OptionSpecs.

Returns:

this builder for method chaining

addOption

public CommandLine.ParseResult.Builder addOption(CommandLine.Model.OptionSpec option)

Adds the specified OptionSpec 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 specified PositionalParamSpec to the list of parameters that were matched on the command line.

Parameters:

positionalParam - the matched PositionalParamSpec

position - the command line position at which the PositionalParamSpec was matched.

Returns:

this builder for method chaining

addUnmatched

private CommandLine.ParseResult.Builder addUnmatched(int position,
 String arg)

Adds the specified command line argument to the list of unmatched command line arguments, and remembers the position of this argument. This position is used in the UnmatchedArgumentException message.

Since:

4.6

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.

totalArgCount

private int totalArgCount()

subcommand

public CommandLine.ParseResult.Builder subcommand(CommandLine.ParseResult subcommand)

Sets the specified ParseResult 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 the CommandLine.parseArgs(String...) method, before @-file expansion.

See Also:

• expandedArgs(Collection)
• CommandLine.ParseResult.originalArgs()

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()

addStringValue

void addStringValue(CommandLine.Model.ArgSpec argSpec,
 String value)

addOriginalStringValue

void addOriginalStringValue(CommandLine.Model.ArgSpec argSpec,
 String value)

addTypedValues

void addTypedValues(CommandLine.Model.ArgSpec argSpec,
 int position,
 Object typedValue)

addError

public void addError(CommandLine.PicocliException ex)

beforeMatchingGroupElement

void beforeMatchingGroupElement(CommandLine.Model.ArgSpec argSpec)
                         throws Exception

Throws:

Exception