Package picocli
Class CommandLine.Model.ArgGroupSpec
- java.lang.Object
-
- picocli.CommandLine.Model.ArgGroupSpec
-
- All Implemented Interfaces:
CommandLine.Model.IOrdered
- Enclosing class:
- CommandLine.Model
public static class CommandLine.Model.ArgGroupSpec extends java.lang.Object implements CommandLine.Model.IOrdered
TheArgGroupSpecclass models agroupof arguments (options, positional parameters or a mixture of the two).- Since:
- 4.0
- See Also:
CommandLine.ArgGroup
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCommandLine.Model.ArgGroupSpec.BuilderBuilder responsible for creating validArgGroupSpecobjects.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<CommandLine.Model.OptionSpec>allOptionsNested()Returns all options configured for this group and all subgroups.java.util.List<CommandLine.Model.PositionalParamSpec>allPositionalParametersNested()Returns all positional parameters configured for this group and all subgroups.java.util.Set<CommandLine.Model.ArgSpec>args()Returns the options and positional parameters in this group; may be empty but notnull.static CommandLine.Model.ArgGroupSpec.Builderbuilder()Returns a newCommandLine.Model.ArgGroupSpec.Builder.static CommandLine.Model.ArgGroupSpec.Builderbuilder(CommandLine.Model.IAnnotatedElement annotatedElement)Returns a newCommandLine.Model.ArgGroupSpec.Builderassociated with the specified annotated element.CommandLine.Help.IParamLabelRenderercreateLabelRenderer(CommandLine.Model.CommandSpec commandSpec)booleanequals(java.lang.Object obj)booleanexclusive()Returns whether this is a mutually exclusive group;trueby default.CommandLine.Model.IGettergetter()Returns theCommandLine.Model.IGetterthat is responsible for supplying the value of the annotated program element associated with this group.inthashCode()java.lang.Stringheading()Returns the heading of this group (may benull), used when generating the usage documentation.java.lang.StringheadingKey()Returns the heading key of this group (may benull), used to get the heading from a resource bundle.booleanisSubgroupOf(CommandLine.Model.ArgGroupSpec group)Returnstrueif this group is a subgroup (or a nested sub-subgroup, to any level of depth) of the specified group,falseotherwise.CommandLine.Model.Messagesmessages()Returns the Messages for this argument group specification, ornull.CommandLine.Model.ArgGroupSpecmessages(CommandLine.Model.Messages msgs)Sets the Messages for this ArgGroupSpec, and returns this ArgGroupSpec.CommandLine.Rangemultiplicity()Returns the multiplicity of this group: how many occurrences it may have on the command line;"0..1"(optional) by default.java.util.List<CommandLine.Model.OptionSpec>options()Returns the list of options configured for this group.intorder()Returns the position in the options list in the usage help message at which this group should be shown.CommandLine.Model.ArgGroupSpecparentGroup()Returns the parent group that this group is part of, ornullif this group is not part of a composite.java.util.List<CommandLine.Model.PositionalParamSpec>positionalParameters()Returns the list of positional parameters configured for this group.java.util.Set<CommandLine.Model.ArgSpec>requiredArgs()Returns the required options and positional parameters in this group; may be empty but notnull.CommandLine.Model.IScopescope()Returns theCommandLine.Model.IScopethat determines where the setter sets the value (or the getter gets the value) of the annotated program element associated with this group.CommandLine.Model.ISettersetter()Returns theCommandLine.Model.ISetterthat is responsible for modifying the value of the annotated program element associated with this group.java.util.List<CommandLine.Model.IAnnotatedElement>specElements()Returns the list of program elements annotated with{@literal @}Specconfigured for this group.java.util.List<CommandLine.Model.ArgGroupSpec>subgroups()Return the subgroups that this group is composed of; may be empty but notnull.java.lang.Stringsynopsis()Returns the synopsis of this group.CommandLine.Help.Ansi.TextsynopsisText(CommandLine.Help.ColorScheme colorScheme, java.util.Set<CommandLine.Model.ArgSpec> outparam_groupArgs)Returns the synopsis of this group.java.lang.StringtoString()CommandLine.Model.ITypeInfotypeInfo()Returns the type info for the annotated program element associated with this group.booleanvalidate()Returns whether picocli should validate the rules of this group: for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line; for a co-occurring group this means that all arguments in the group are specified on the command line.
-
-
-
Method Detail
-
builder
public static CommandLine.Model.ArgGroupSpec.Builder builder()
Returns a newCommandLine.Model.ArgGroupSpec.Builder.- Returns:
- a new ArgGroupSpec.Builder instance
-
builder
public static CommandLine.Model.ArgGroupSpec.Builder builder(CommandLine.Model.IAnnotatedElement annotatedElement)
Returns a newCommandLine.Model.ArgGroupSpec.Builderassociated with the specified annotated element.- Parameters:
annotatedElement- the annotated element containing@Optionand@Parameters- Returns:
- a new ArgGroupSpec.Builder instance
-
exclusive
public boolean exclusive()
Returns whether this is a mutually exclusive group;trueby default. Iffalse, this is a co-occurring group. Ignored ifvalidate()isfalse.- See Also:
CommandLine.ArgGroup.exclusive()
-
multiplicity
public CommandLine.Range multiplicity()
Returns the multiplicity of this group: how many occurrences it may have on the command line;"0..1"(optional) by default. A group can be made required by specifying a multiplicity of"1". For a group of mutually exclusive arguments, being required means that one of the arguments in the group must appear on the command line, or a MissingParameterException is thrown. For a group of co-occurring arguments, being required means that all arguments in the group must appear on the command line. Ignored ifvalidate()isfalse.- See Also:
CommandLine.ArgGroup.multiplicity()
-
validate
public boolean validate()
Returns whether picocli should validate the rules of this group: for a mutually exclusive group this means that no more than one arguments in the group is specified on the command line; for a co-occurring group this means that all arguments in the group are specified on the command line.trueby default.- See Also:
CommandLine.ArgGroup.validate()
-
order
public int order()
Returns the position in the options list in the usage help message at which this group should be shown. Groups with a lower number are shown before groups with a higher number. This attribute is only honored for groups that have aheading(or aheadingKeywith a non-nullresource bundle value).- Specified by:
orderin interfaceCommandLine.Model.IOrdered
-
heading
public java.lang.String heading()
Returns the heading of this group (may benull), used when generating the usage documentation.- See Also:
CommandLine.ArgGroup.heading()
-
headingKey
public java.lang.String headingKey()
Returns the heading key of this group (may benull), used to get the heading from a resource bundle.- See Also:
CommandLine.ArgGroup.headingKey()
-
parentGroup
public CommandLine.Model.ArgGroupSpec parentGroup()
Returns the parent group that this group is part of, ornullif this group is not part of a composite.
-
subgroups
public java.util.List<CommandLine.Model.ArgGroupSpec> subgroups()
Return the subgroups that this group is composed of; may be empty but notnull.- Returns:
- immutable list of subgroups that this group is composed of.
-
specElements
public java.util.List<CommandLine.Model.IAnnotatedElement> specElements()
Returns the list of program elements annotated with{@literal @}Specconfigured for this group.- Since:
- 4.6
-
isSubgroupOf
public boolean isSubgroupOf(CommandLine.Model.ArgGroupSpec group)
Returnstrueif this group is a subgroup (or a nested sub-subgroup, to any level of depth) of the specified group,falseotherwise.- Parameters:
group- the group to check if it contains this group- Returns:
trueif this group is a subgroup or a nested sub-subgroup of the specified group
-
typeInfo
public CommandLine.Model.ITypeInfo typeInfo()
Returns the type info for the annotated program element associated with this group.- Returns:
- type information that does not require
Classobjects and be constructed both at runtime and compile time
-
getter
public CommandLine.Model.IGetter getter()
Returns theCommandLine.Model.IGetterthat is responsible for supplying the value of the annotated program element associated with this group.
-
setter
public CommandLine.Model.ISetter setter()
Returns theCommandLine.Model.ISetterthat is responsible for modifying the value of the annotated program element associated with this group.
-
scope
public CommandLine.Model.IScope scope()
Returns theCommandLine.Model.IScopethat determines where the setter sets the value (or the getter gets the value) of the annotated program element associated with this group.
-
args
public java.util.Set<CommandLine.Model.ArgSpec> args()
Returns the options and positional parameters in this group; may be empty but notnull.
-
requiredArgs
public java.util.Set<CommandLine.Model.ArgSpec> requiredArgs()
Returns the required options and positional parameters in this group; may be empty but notnull.
-
positionalParameters
public java.util.List<CommandLine.Model.PositionalParamSpec> positionalParameters()
Returns the list of positional parameters configured for this group.- Returns:
- an immutable list of positional parameters in this group.
-
options
public java.util.List<CommandLine.Model.OptionSpec> options()
Returns the list of options configured for this group.- Returns:
- an immutable list of options in this group.
-
allOptionsNested
public java.util.List<CommandLine.Model.OptionSpec> allOptionsNested()
Returns all options configured for this group and all subgroups.- Returns:
- an immutable list of all options in this group and its subgroups.
- Since:
- 4.4
-
allPositionalParametersNested
public java.util.List<CommandLine.Model.PositionalParamSpec> allPositionalParametersNested()
Returns all positional parameters configured for this group and all subgroups.- Returns:
- an immutable list of all positional parameters in this group and its subgroups.
- Since:
- 4.4
-
synopsis
public java.lang.String synopsis()
Returns the synopsis of this group.
-
synopsisText
public CommandLine.Help.Ansi.Text synopsisText(CommandLine.Help.ColorScheme colorScheme, java.util.Set<CommandLine.Model.ArgSpec> outparam_groupArgs)
Returns the synopsis of this group.- Parameters:
colorScheme- the color scheme to use for options and positional parameters in this group and subgroupsoutparam_groupArgs- all options and positional parameters in the groups this method generates a synopsis for; these options and positional parameters should be excluded from appearing elsewhere in the synopsis- Returns:
- the synopsis Text
-
createLabelRenderer
public CommandLine.Help.IParamLabelRenderer createLabelRenderer(CommandLine.Model.CommandSpec commandSpec)
-
messages
public CommandLine.Model.Messages messages()
Returns the Messages for this argument group specification, ornull.
-
messages
public CommandLine.Model.ArgGroupSpec messages(CommandLine.Model.Messages msgs)
Sets the Messages for this ArgGroupSpec, and returns this ArgGroupSpec.- Parameters:
msgs- the new Messages value, may benull- See Also:
CommandLine.Command.resourceBundle(),headingKey()
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-