MultiStringOption class

Convenience class for multi-value configuration option for strings.

Inheritance

• Object
• ConfigOptionBase<List<String>>
• MultiOption<String>
• MultiStringOption

Constructors

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

Creates a MultiStringOption which splits input strings on commas.

const

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

Creates a MultiStringOption which treats input strings as single elements.

const

Properties

allowedElementValues → List<String>?

final, inherited

allowedHelp → Map<String, String>?

final, inherited

allowedValues → List<List<String>>?

final, inherited

argAbbrev → String?

final, inherited

argAliases → List<String>?

final, inherited

argName → String?

final, inherited

argPos → int?

final, inherited

configKey → String?

final, inherited

customValidator → void Function(List<String> value)?

final, inherited

defaultsTo → List<String>?

final, inherited

envName → String?

final, inherited

fromCustom → List<String>? Function(Configuration<OptionDefinition> cfg)?

final, inherited

fromDefault → List<String> Function()?

final, inherited

group → OptionGroup?

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

helpText → String?

final, inherited

hide → bool

final, inherited

mandatory → bool

final, inherited

option → ConfigOptionBase<List<String>>

Returns self.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

valueHelp → String?

final, inherited

valueParser → ValueParser<List<String>>

final, inherited

Methods

defaultValue() → List<String>?

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<String>>

////////////////// 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<String>? value) → String?

Returns an error message if the value is invalid, or null if valid.

inherited

validateValue(List<String> 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.

inherited

valueHelpString() → String?

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited