StateValidator class

StateValidator extends TranslatedValidator to validate if a string represents a valid state name.

This validator checks if the state name matches a specified regex pattern and is not in a blacklist, and optionally checks if it is in a whitelist.

Parameters:

regex The regular expression used to validate the state name format. Defaults to a standard state name regex.
stateWhitelist A list of valid state names that are explicitly allowed.
stateBlacklist A list of invalid state names that are explicitly disallowed.
errorText The error message returned if the validation fails.
checkNullOrEmpty Whether to check if the value is null or empty.

Inheritance

StateValidator.new({RegExp? regex, List<String> stateWhitelist = const <String>[], List<String> stateBlacklist = const <String>[], String? errorText, bool checkNullOrEmpty = true}): Constructor for the state name validator.

checkNullOrEmpty → bool: Whether to check if the value is null or empty.
finalinherited
errorText → String: The error message returned if the value is invalid.
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
regex → RegExp: The regular expression used to validate the state name format.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
stateBlacklist → List<String>: A list of invalid state names that are explicitly disallowed.
final
stateWhitelist → List<String>: A list of valid state names that are explicitly allowed.
final
translatedErrorText → String: The translated error message returned if the value is invalid.
no setteroverride

isNullOrEmpty(String? valueCandidate) → bool: Checks if the value is null or empty. Returns true if the value is null or empty, otherwise false. The value is considered empty if it is a String, Iterable, or Map and it is empty or contains only whitespace characters. If the value is not a String, Iterable, or Map, it is considered empty if it is null.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited
validate(String? valueCandidate) → String?: Validates the value and checks if it is null or empty.
inherited
validateValue(String valueCandidate) → String?: Validates the value. Returns null if the value is valid, otherwise an error message. Call validate() instead of this method when using the validator.
override