Package picocli

Class CommandLine.ParseResult.GroupMatch

java.lang.Object

picocli.CommandLine.ParseResult.GroupMatch

Enclosing class:

CommandLine.ParseResult

public static class CommandLine.ParseResult.GroupMatch
extends Object

A group's multiplicity specifies how many matches of a group may appear on the command line. This class models a single "match". For example, this group: (-a -b) (-a -b) requires two matches of its arguments to fully match.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final CommandLine.ParseResult.GroupMatchContainer	container
(package private) Map<CommandLine.Model.ArgGroupSpec,CommandLine.ParseResult.GroupMatchContainer>	matchedSubgroups
(package private) Map<CommandLine.Model.ArgSpec,List<Object>>	matchedValues
(package private) Map<CommandLine.Model.ArgSpec,Map<Integer,List<Object>>>	matchedValuesAtPosition
(package private) Map<CommandLine.Model.ArgSpec,List<String>>	originalStringValues
(package private) int	position
(package private) final int	startPosition
private CommandLine.ParseResult.GroupValidationResult	validationResult

Constructor Summary

Constructors

Constructor	Description
GroupMatch(CommandLine.ParseResult.GroupMatchContainer container)

Method Summary

Modifier and Type	Method	Description
(package private) void	addMatchedValue(CommandLine.Model.ArgSpec argSpec, int matchPosition, Object stronglyTypedValue, CommandLine.Tracer tracer)
(package private) void	addOriginalStringValue(CommandLine.Model.ArgSpec argSpec, String value)
CommandLine.ParseResult.GroupMatchContainer	container()	Returns the container GroupMatchContainer of this match.
CommandLine.Model.ArgGroupSpec	group()	Returns the ArgGroupSpec of the container GroupMatchContainer of this match.
private boolean	hasFullyMatchedSubgroup(boolean allRequired)
(package private) boolean	hasMatchedValueAtPosition(CommandLine.Model.ArgSpec arg, int position)
boolean	isEmpty()	Returns true if this match has no matched arguments and no matched subgroups.
(package private) int	matchCount(CommandLine.Model.ArgSpec argSpec)
private boolean	matchedFully(boolean allRequired)
(package private) boolean	matchedMaxElements()	Returns true if the maximum number of matches has been reached for this match: all arguments (required or not) have been matched, and for each subgroup, the maximum number of elements have been matched.
(package private) boolean	matchedMinElements()	Returns true if the minimum number of elements have been reached for this match: all required arguments have been matched, and for each subgroup, the minimum number of elements have been matched.
Map<CommandLine.Model.ArgGroupSpec,CommandLine.ParseResult.GroupMatchContainer>	matchedSubgroups()	Returns matches for the subgroups, if any.
List<Object>	matchedValues(CommandLine.Model.ArgSpec argSpec)	Returns the values matched for the specified argument, converted to the type of the argument.
String	toString()
private StringBuilder	toString(StringBuilder result)
(package private) void	validate(CommandLine commandLine)

Methods inherited from class java.lang.Object

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

Field Details

position

int position

startPosition

final int startPosition

container

final CommandLine.ParseResult.GroupMatchContainer container

matchedSubgroups

Map<CommandLine.Model.ArgGroupSpec,CommandLine.ParseResult.GroupMatchContainer> matchedSubgroups

matchedValues

Map<CommandLine.Model.ArgSpec,List<Object>> matchedValues

originalStringValues

Map<CommandLine.Model.ArgSpec,List<String>> originalStringValues

matchedValuesAtPosition

Map<CommandLine.Model.ArgSpec,Map<Integer,List<Object>>> matchedValuesAtPosition

validationResult

private CommandLine.ParseResult.GroupValidationResult validationResult

Constructor Details

GroupMatch

GroupMatch(CommandLine.ParseResult.GroupMatchContainer container)

Method Details

isEmpty

public boolean isEmpty()

Returns true if this match has no matched arguments and no matched subgroups.

group

public CommandLine.Model.ArgGroupSpec group()

Returns the ArgGroupSpec of the container GroupMatchContainer of this match.

container

public CommandLine.ParseResult.GroupMatchContainer container()

Returns the container GroupMatchContainer of this match.

matchedSubgroups

public Map<CommandLine.Model.ArgGroupSpec,CommandLine.ParseResult.GroupMatchContainer> matchedSubgroups()

Returns matches for the subgroups, if any.

matchCount

int matchCount(CommandLine.Model.ArgSpec argSpec)

matchedValues

public List<Object> matchedValues(CommandLine.Model.ArgSpec argSpec)

Returns the values matched for the specified argument, converted to the type of the argument.

addOriginalStringValue

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

addMatchedValue

void addMatchedValue(CommandLine.Model.ArgSpec argSpec,
 int matchPosition,
 Object stronglyTypedValue,
 CommandLine.Tracer tracer)

hasMatchedValueAtPosition

boolean hasMatchedValueAtPosition(CommandLine.Model.ArgSpec arg,
 int position)

matchedMinElements

boolean matchedMinElements()

Returns true if the minimum number of elements have been reached for this match: all required arguments have been matched, and for each subgroup, the minimum number of elements have been matched.

matchedMaxElements

boolean matchedMaxElements()

Returns true if the maximum number of matches has been reached for this match: all arguments (required or not) have been matched, and for each subgroup, the maximum number of elements have been matched.

matchedFully

private boolean matchedFully(boolean allRequired)

hasFullyMatchedSubgroup

private boolean hasFullyMatchedSubgroup(boolean allRequired)

toString

public String toString()

Overrides:

toString in class Object

toString

private StringBuilder toString(StringBuilder result)

validate

void validate(CommandLine commandLine)