Schema class
Basic schema that validates values against a set of validation rules.
This schema is used as a basis for specific schemas to validate objects, project properties, arrays and maps.
See ObjectSchema See PropertySchema See ArraySchema See MapSchema
- Implementers
Constructors
-
Schema([bool? req, List<
IValidationRule> ? rules]) - Creates a new instance of validation schema and sets its values.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
getRules(
) → List< IValidationRule> ? - Gets validation rules to check values against.
-
isRequired(
) → bool - Gets a flag that always requires non-null values. For null values it raises a validation error.
-
makeOptional(
) → Schema - Makes validated values optional. Validation for null values will be skipped.
-
makeRequired(
) → Schema - Makes validated values always required (non-null). For null values the schema will raise errors.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
performTypeValidation(
String? path, dynamic type, dynamic value, List< ValidationResult> results) → void - Validates a given value to match specified type. The type can be defined as a Schema, type, a type name or TypeCode When type is a Schema, it executes validation recursively against that Schema.
-
performValidation(
String? path, dynamic value, List< ValidationResult> results) → void - Validates a given value against the schema and configured validation rules.
-
setRequired(
bool value) → void - Sets a flag that always requires non-null values.
-
setRules(
List< IValidationRule> value) → void - Sets validation rules to check values against.
-
toString(
) → String -
A string representation of this object.
inherited
-
validate(
dynamic value) → List< ValidationResult> - Validates the given value and results validation results.
-
validateAndReturnException(
String? correlationId, dynamic value, [bool strict = false]) → ValidationException? - Validates the given value and returns a ValidationException if errors were found.
-
validateAndThrowException(
String? correlationId, dynamic value, [bool strict = false]) → void - Validates the given value and throws a ValidationException if errors were found.
-
withRule(
IValidationRule rule) → Schema - Adds validation rule to this schema.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited