DirOption class
Directory path configuration option.
If the input is not valid according to the mode, the validation throws a UsageException.
- Inheritance
-
- Object
- ConfigOptionBase<
Directory> - DirOption
Constructors
-
DirOption({String? argName, List<
String> ? argAliases, String? argAbbrev, int? argPos, String? envName, String? configKey, Directory? fromCustom(Configuration<OptionDefinition> cfg)?, Directory fromDefault()?, Directory? defaultsTo, String? helpText, String? valueHelp, OptionGroup? group, void customValidator(Directory value)?, bool mandatory = false, bool hide = false, PathExistMode mode = PathExistMode.mayExist}) -
const
Properties
-
allowedHelp
→ Map<
String, String> ? -
finalinherited
-
allowedValues
→ List<
Directory> ? -
finalinherited
- argAbbrev → String?
-
finalinherited
-
argAliases
→ List<
String> ? -
finalinherited
- argName → String?
-
finalinherited
- argPos → int?
-
finalinherited
- configKey → String?
-
finalinherited
- customValidator → void Function(Directory value)?
-
finalinherited
- defaultsTo → Directory?
-
finalinherited
- envName → String?
-
finalinherited
-
fromCustom
→ Directory? Function(Configuration<
OptionDefinition> cfg)? -
finalinherited
- fromDefault → Directory Function()?
-
finalinherited
- group → OptionGroup?
-
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- helpText → String?
-
finalinherited
- hide → bool
-
finalinherited
- mandatory → bool
-
finalinherited
- mode → PathExistMode
-
final
-
option
→ ConfigOptionBase<
Directory> -
Returns self.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- valueHelp → String?
-
finalinherited
-
valueParser
→ ValueParser<
Directory> -
finalinherited
Methods
-
defaultValue(
) → Directory? -
inherited
-
defaultValueString(
) → String? -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
qualifiedString(
) → String -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
validateDefinition(
) → void -
Validates the configuration option definition.
inherited
-
validateValue(
Directory 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