validator_annotation library

Provides validator annotation classes to use with

validator_annotation_generator.

Classes

ClassValidator
An annotation used to specify a class to generate code for.
IsAlphabetValidator
Metadata to validate if String instance is alphabet or not
IsEmailValidator
IsEmailValidator is metadata validator to check email address
IsEmptyStringValidator
IsEmptyStringValidator Decorator
IsNegativeNumberValidator
Validator metadata to check if number is negative
IsNotEmptyStringValidator
IsNotEmptyStringValidator Decorator
IsPositiveNumberValidator
Validator metadata to check if number is positive
IsStringNumberValidator
validate is instance of String is number or not
IsStringValidator
Metadata validator to check if value is instance of String
IsZeroValidator
Validator metadata to check if number is zero
MaxStringLengthValidator
Metadata validator check if instance of String has maximum of length
MaxValueNumberValidator
Validator metadata to check if a number lower than or equal to value
MinMaxStringLengthValidator
Metadata validator check if instance of String has length between maxLength and minLength
MinMaxValueNumberValidator
Validator metadata to check if a number value between minValue and maxValue
MinStringLengthValidator
Metadata validator check if instance of String has minimum of length
MinValueNumberValidator
Validator metadata to check if a number higher than or equal to value
ObjectValidator
ValidationData
Represents data used for validation, including the value to be validated and a list of validator annotation.
ValidatorAnnotation
Create ValidatorAnnotation

Enums

NamingConvention
Values for the automatic function validator name renaming behavior for ClassValidator.

Constants

isEmptyStringValidator → const IsEmptyStringValidator
shortcut for IsEmptyStringValidator decorator without parameter
isNegativeNumberValidator → const IsNegativeNumberValidator
shortcut for IsNegativeNumberValidator
isNotEmptyStringValidator → const IsNotEmptyStringValidator
shortcut for IsNotEmptyStringValidator decorator without parameter
isPositiveNumberValidator → const IsPositiveNumberValidator
shortcut for IsPositiveNumberValidator
isStringNumberValidator → const IsStringNumberValidator
shortcut for IsStringNumberValidator decorator without parameter
isStringValidator → const IsStringValidator
shortcut for IsStringValidator decorator without parameter
isZeroValidator → const IsZeroValidator
shortcut for IsZeroValidator

Functions

assertNullableString({dynamic value, bool allowNullable = false}) → void
Asserts that the given value is a String, and optionally allows null if specified.
assertNumeric({dynamic value, bool allowNullable = false}) → void
validateField(dynamic value, List<ValidatorAnnotation> annotations) → String?
Validates a field using a list of ValidatorAnnotation annotations.
validateInstance(List<ValidationData> validationDatas, {bool stopWhenFirstError = true}) → ValidationResult
validateIsAlphabet({String? value, bool onlyAcceptLowerCase = false, bool allowMultiline = true, bool trimWhiteSpace = true}) → bool
check if the value is alphabet or not
validateIsEmpty({String? value, bool excludeWhiteSpace = true}) → bool
check if the value is empty or not
validateIsNegative<T extends num>(T value) → bool
validate if value is negative
validateIsNotNegative<T extends num>(T value) → bool
validate if value is not negative
validateIsNotPositive<T extends num>(T value) → bool
validate if value is not positive
validateIsNotZero<T extends num>(T value) → bool
validate if value lower than zero or higher than zero
validateIsPositive<T extends num>(T value) → bool
validate if value is positive
validateIsStringDouble({required String value}) → bool
validate is string value can be parsed to double or not
validateIsStringInteger({required String value}) → bool
validate is string value can be parsed to integer or not
validateIsStringNumber({required String value}) → bool
validate is string value can be parsed to numeric or not
validateMaxStringLength({required int length, required String value}) → bool
validate is string value have max length <= length
validateMaxValue<T extends num>({required T value, required T maxValue}) → bool
validate if value <= maxValue
validateMinMaxStringLength({required int minLength, required int maxLength, required String value}) → bool
validate is string value length >= minLength and <= maxLength
validateMinMaxValue<T extends num>({required T value, required T minValue, required T maxValue}) → bool
validate if value >= minValue and value <= maxValue
validateMinStringLength({required int length, required String value}) → bool
validate is string value have min length >= length
validateMinValue<T extends num>({required T value, required T minValue}) → bool
validate if value >= minValue

Typedefs

ObjectValidatorErrorMessageBuilder = String Function(String fieldName, String errorMessage)
ObjectValidatorValidateFunction = ValidationResult Function(dynamic value)

Exceptions / Errors

ValidationError
ValidationResult
A holder class to hold validation result