MultiOption<T> class

Multi-value configuration option.

Inheritance
Implementers

Constructors

MultiOption.new({required MultiParser<T> multiParser, String? argName, List<String>? argAliases, String? argAbbrev, String? envName, String? configKey, List<T>? fromCustom(Configuration<OptionDefinition> cfg)?, List<T> fromDefault()?, List<T>? defaultsTo, String? helpText, String? valueHelp, Map<String, String>? allowedHelp, OptionGroup? group, List<T>? allowedValues, void customValidator(List<T> value)?, bool mandatory = false, bool hide = false})
const

Properties

allowedElementValues → List<T>?
final
allowedHelp → Map<String, String>?
finalinherited
allowedValues → List<List<T>>?
finalinherited
argAbbrev → String?
finalinherited
argAliases → List<String>?
finalinherited
argName → String?
finalinherited
argPos → int?
finalinherited
configKey → String?
finalinherited
customValidator → void Function(List<T> value)?
finalinherited
defaultsTo → List<T>?
finalinherited
envName → String?
finalinherited
fromCustom → List<T>? Function(Configuration<OptionDefinition> cfg)?
finalinherited
fromDefault → List<T> Function()?
finalinherited
group → OptionGroup?
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
helpText → String?
finalinherited
hide → bool
finalinherited
mandatory → bool
finalinherited
option → ConfigOptionBase<List<T>>
Returns self.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
valueHelp → String?
finalinherited
valueParser → ValueParser<List<T>>
finalinherited

Methods

defaultValue() → List<T>?
inherited
defaultValueString() → String?
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
qualifiedString() → String
inherited
resolveValue(Configuration<OptionDefinition> cfg, {ArgResults? args, Iterator<String>? posArgs, Map<String, String>? env, ConfigurationBroker<OptionDefinition>? configBroker}) → OptionResolution<List<T>>
////////////////// Returns the resolved value of this configuration option from the provided context. For options with positional arguments this must be invoked in ascending position order. Returns the result with the resolved value or error.
inherited
toString() → String
A string representation of this object.
inherited
validateDefinition() → void
Validates the configuration option definition.
inherited
validateOptionValue(List<T>? value) → String?
Returns an error message if the value is invalid, or null if valid.
inherited
validateValue(List<T> value) → void
Validates the parsed value, throwing a FormatException if the value is invalid, or a UsageException if the value is invalid for other reasons.
override
valueHelpString() → String?
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited