Package picocli

Class CommandLine.ParseResult.GroupMatchContainer

java.lang.Object

picocli.CommandLine.ParseResult.GroupMatchContainer

Enclosing class:

CommandLine.ParseResult

public static class CommandLine.ParseResult.GroupMatchContainer
extends Object

Provides information about an CommandLine.ArgGroup that was matched on the command line.

The ParseResult may have more than one GroupMatchContainer for an ArgGroupSpec, when the group was matched more often than its maximum multiplicity. This is not necessarily a problem: the parser will add a match to the parent matched group until the maximum multiplicity of the parent group is exceeded, in which case parser will add a match to the parent's parent group, etc.

Ultimately, as long as the CommandLine.ParseResult.getGroupMatches() method does not return more than one match, the maximum number of elements is not exceeded.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final CommandLine.Model.ArgGroupSpec	group
private final List<CommandLine.ParseResult.GroupMatch>	matches
private CommandLine.ParseResult.GroupMatchContainer	parentContainer
private final List<CommandLine.Model.ArgGroupSpec>	unmatchedSubgroups
private CommandLine.ParseResult.GroupValidationResult	validationResult

Constructor Summary

Constructors

Constructor	Description
GroupMatchContainer(CommandLine.Model.ArgGroupSpec group, CommandLine cmd)

Method Summary

Modifier and Type	Method	Description
(package private) void	addMatch(CommandLine commandLine)
(package private) boolean	canMatchPositionalParam(CommandLine.Model.PositionalParamSpec positionalParam)
(package private) void	complete(CommandLine commandLine)
private boolean	containsRequiredSubgroups(CommandLine.Model.ArgGroupSpec argGroupSpec)
private CommandLine.ParseResult.GroupMatchContainer	createGroupMatchContainer(CommandLine.Model.ArgGroupSpec group, CommandLine.ParseResult.GroupMatchContainer parent, CommandLine commandLine)
private void	failGroupMultiplicityExceeded(List<CommandLine.ParseResult.GroupMatch> groupMatches, CommandLine commandLine)
(package private) CommandLine.ParseResult.GroupMatchContainer	findLastMatchContainer(CommandLine.Model.ArgGroupSpec group)
(package private) List<CommandLine.ParseResult.GroupMatchContainer>	findMatchContainers(CommandLine.Model.ArgGroupSpec group, List<CommandLine.ParseResult.GroupMatchContainer> result)
private CommandLine.ParseResult.GroupMatchContainer	findOrCreateMatchingGroup(CommandLine.Model.ArgSpec argSpec, CommandLine commandLine)
CommandLine.Model.ArgGroupSpec	group()	Returns the ArgGroupSpec whose matches are captured in this GroupMatchContainer.
private boolean	isGroupEffectivelyOptional(CommandLine.Model.ArgGroupSpec argGroupSpec)	A group is optional if its minimum multiplicity is zero otherwise, if the group has at least one required option and all required options have default values Conversely, a group is required if if its minimum multiplicity is 1 or more AND either the group has no required options or the group has at least one required option without a default value
(package private) boolean	isMaxMultiplicityReached()	Returns true if no more MatchedGroupMultiples can be added to this GroupMatchContainer.
(package private) boolean	isMinMultiplicityReached()	Returns true if this GroupMatchContainer has at least the minimum number of MatchedGroupMultiples.
(package private) CommandLine.ParseResult.GroupMatch	lastMatch()	Returns the "active" multiple of this GroupMatchContainer.
private boolean	matchedFully(boolean allRequired)
(package private) boolean	matchedMaxElements()	Returns true if the maximum number of multiples has been matched for the multiplicity of this group, and the last multiple has matched the maximum number of elements, while all other multiples have matched at least the minimum number of elements.
(package private) boolean	matchedMinElements()	Returns true if the minimum number of multiples has been matched for the multiplicity of this group, and each multiple has matched at least the minimum number of elements.
List<CommandLine.ParseResult.GroupMatch>	matches()	Returns the list of GroupMatch instances: ArgGroupSpecs with a multiplicity greater than one may be matched multiple times.
private boolean	requiredOptionsExistAndAllHaveDefaultValues(CommandLine.Model.ArgGroupSpec argGroupSpec)
private boolean	simplifyErrorMessageForSingleGroup(Map<CommandLine.Model.ArgGroupSpec,List<List<CommandLine.ParseResult.GroupMatch>>> matchesPerGroup, CommandLine commandLine)
String	toString()
private StringBuilder	toString(StringBuilder result)
(package private) CommandLine.ParseResult.GroupMatchContainer	trim()
(package private) void	updateUnmatchedGroups(CommandLine.Model.ArgGroupSpec group)
(package private) void	validate(CommandLine commandLine)
private void	validateGroupMultiplicity(CommandLine commandLine)

Methods inherited from class java.lang.Object

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

Field Details

group

private final CommandLine.Model.ArgGroupSpec group

parentContainer

private CommandLine.ParseResult.GroupMatchContainer parentContainer

unmatchedSubgroups

private final List<CommandLine.Model.ArgGroupSpec> unmatchedSubgroups

matches

private final List<CommandLine.ParseResult.GroupMatch> matches

validationResult

private CommandLine.ParseResult.GroupValidationResult validationResult

Constructor Details

GroupMatchContainer

GroupMatchContainer(CommandLine.Model.ArgGroupSpec group,
 CommandLine cmd)

Method Details

group

public CommandLine.Model.ArgGroupSpec group()

Returns the ArgGroupSpec whose matches are captured in this GroupMatchContainer.

matches

public List<CommandLine.ParseResult.GroupMatch> matches()

Returns the list of GroupMatch instances: ArgGroupSpecs with a multiplicity greater than one may be matched multiple times.

addMatch

void addMatch(CommandLine commandLine)

complete

void complete(CommandLine commandLine)

lastMatch

CommandLine.ParseResult.GroupMatch lastMatch()

Returns the "active" multiple of this GroupMatchContainer.

isMaxMultiplicityReached

boolean isMaxMultiplicityReached()

Returns true if no more MatchedGroupMultiples can be added to this GroupMatchContainer. Each multiple may be a complete or an incomplete match.

isMinMultiplicityReached

boolean isMinMultiplicityReached()

Returns true if this GroupMatchContainer has at least the minimum number of MatchedGroupMultiples. Each multiple may be a complete or an incomplete match.

matchedMinElements

boolean matchedMinElements()

Returns true if the minimum number of multiples has been matched for the multiplicity of this group, and each multiple has matched at least the minimum number of elements.

matchedMaxElements

boolean matchedMaxElements()

Returns true if the maximum number of multiples has been matched for the multiplicity of this group, and the last multiple has matched the maximum number of elements, while all other multiples have matched at least the minimum number of elements.

matchedFully

private boolean matchedFully(boolean allRequired)

findOrCreateMatchingGroup

private CommandLine.ParseResult.GroupMatchContainer findOrCreateMatchingGroup(CommandLine.Model.ArgSpec argSpec,
 CommandLine commandLine)

createGroupMatchContainer

private CommandLine.ParseResult.GroupMatchContainer createGroupMatchContainer(CommandLine.Model.ArgGroupSpec group,
 CommandLine.ParseResult.GroupMatchContainer parent,
 CommandLine commandLine)

trim

CommandLine.ParseResult.GroupMatchContainer trim()

findMatchContainers

List<CommandLine.ParseResult.GroupMatchContainer> findMatchContainers(CommandLine.Model.ArgGroupSpec group,
 List<CommandLine.ParseResult.GroupMatchContainer> result)

findLastMatchContainer

CommandLine.ParseResult.GroupMatchContainer findLastMatchContainer(CommandLine.Model.ArgGroupSpec group)

toString

public String toString()

Overrides:

toString in class Object

toString

private StringBuilder toString(StringBuilder result)

updateUnmatchedGroups

void updateUnmatchedGroups(CommandLine.Model.ArgGroupSpec group)

validate

void validate(CommandLine commandLine)

isGroupEffectivelyOptional

private boolean isGroupEffectivelyOptional(CommandLine.Model.ArgGroupSpec argGroupSpec)

A group is optional if

• its minimum multiplicity is zero
• otherwise, if the group has at least one required option and all required options have default values

Conversely, a group is required if

• if its minimum multiplicity is 1 or more AND
• • either the group has no required options
  • or the group has at least one required option without a default value

See Also:

• https://github.com/remkop/picocli/issues/1848 and https://github.com/remkop/picocli/issues/2059

requiredOptionsExistAndAllHaveDefaultValues

private boolean requiredOptionsExistAndAllHaveDefaultValues(CommandLine.Model.ArgGroupSpec argGroupSpec)

containsRequiredSubgroups

private boolean containsRequiredSubgroups(CommandLine.Model.ArgGroupSpec argGroupSpec)

failGroupMultiplicityExceeded

private void failGroupMultiplicityExceeded(List<CommandLine.ParseResult.GroupMatch> groupMatches,
 CommandLine commandLine)

simplifyErrorMessageForSingleGroup

private boolean simplifyErrorMessageForSingleGroup(Map<CommandLine.Model.ArgGroupSpec,List<List<CommandLine.ParseResult.GroupMatch>>> matchesPerGroup,
 CommandLine commandLine)

validateGroupMultiplicity

private void validateGroupMultiplicity(CommandLine commandLine)

canMatchPositionalParam

boolean canMatchPositionalParam(CommandLine.Model.PositionalParamSpec positionalParam)