DateTimeOption class
Date-time value configuration option.
Supports minimum and maximum range checking.
- Inheritance
-
- Object
- ConfigOptionBase<
DateTime> - ComparableValueOption<
DateTime> - DateTimeOption
Constructors
-
DateTimeOption.new({String? argName, List<
String> ? argAliases, String? argAbbrev, int? argPos, String? envName, String? configKey, DateTime? fromCustom(Configuration<OptionDefinition> cfg)?, DateTime fromDefault()?, DateTime? defaultsTo, String? helpText, String? valueHelp = 'YYYY-MM-DDtHH:MM:SSz', Map<String, String> ? allowedHelp, OptionGroup? group, List<DateTime> ? allowedValues, void customValidator(DateTime value)?, bool mandatory = false, bool hide = false, DateTime? min, DateTime? max}) -
const
Properties
-
allowedHelp
→ Map<
String, String> ? -
finalinherited
-
allowedValues
→ List<
DateTime> ? -
finalinherited
- argAbbrev → String?
-
finalinherited
-
argAliases
→ List<
String> ? -
finalinherited
- argName → String?
-
finalinherited
- argPos → int?
-
finalinherited
- configKey → String?
-
finalinherited
- customValidator → void Function(DateTime value)?
-
finalinherited
- defaultsTo → DateTime?
-
finalinherited
- envName → String?
-
finalinherited
-
fromCustom
→ DateTime? Function(Configuration<
OptionDefinition> cfg)? -
finalinherited
- fromDefault → DateTime Function()?
-
finalinherited
- group → OptionGroup?
-
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- helpText → String?
-
finalinherited
- hide → bool
-
finalinherited
- mandatory → bool
-
finalinherited
- max → DateTime?
-
finalinherited
- min → DateTime?
-
finalinherited
-
option
→ ConfigOptionBase<
DateTime> -
Returns self.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- valueHelp → String?
-
finalinherited
-
valueParser
→ ValueParser<
DateTime> -
finalinherited
Methods
-
defaultValue(
) → DateTime? -
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<DateTime> -
//////////////////
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(
DateTime? value) → String? -
Returns an error message if the value is invalid, or null if valid.
inherited
-
validateValue(
DateTime 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