Description
The Schema class provides a basic schema to validate values against a set of validation rules.
Important points
- This schema is used as a basis for specific schemas to validate objects, project properties, arrays and maps.
Constructors
Creates a new instance of validation schema and sets its values.
See IValidationRule
public
Schema(boolean required, List<IValidationRule> rules)
- required: boolean - (optional) true to always require non-null values.
- rules: List<IValidationRule> - (optional) list with validation rules.
Instance methods
getRules
Gets validation rules to check values against.
public
List<IValidationRule> getRules()
- returns: List<IValidationRule> - list with validation rules.
isRequired
Gets a flag that always requires non-null values. For null values, it raises a validation error.
public
boolean isRequired()
- returns: boolean - true to always require non-null values and false to allow null values.
makeOptional
Makes validated values optional. Validation for null values will be skipped. This method returns a reference to this exception to implement the Builder pattern to chain additional calls.
public
Schema makeOptional()
- returns: [Schema] - validation schema
makeRequired
Makes validated values always required (non-null). For null values the schema will raise errors. This method returns a reference to this exception to implement the Builder pattern to chain additional calls.
public
[Schema] makeRequired()
- returns: [Schema] - validation schema
performTypeValidation
Validates a given value to match a 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.
protected
void performTypeValidation(String path, Object type, Object value, List<ValidationResult> results)
- path: String - dot notation path to the value.
- type: Object - type to match the value type
- value: Object - value to be validated.
- results: List<ValidationResult> - list with validation results.
performValidation
Validates a given value against the schema and configured validation rules.
protected
void performValidation(String path, Object value, List<ValidationResult> results)
- path: String - dot notation path to the value.
- value: Object - value to be validated.
- results: List<ValidationResult> - list with validation results to add new results.
setRequired
Sets a flag that always requires non-null values.
public
void setRequired(boolean value)
- value: boolean - true to always require non-null values and false to allow null values.
setRules
Sets validation rules to check values against.
public
void setRules(List<IValidationRule> value)
- value: List<IValidationRule> - list with validation rules.
validate
Validates the given value and returns a list with validation results. See ValidationResult
public
List<ValidationResult> validate(Object value)
- value: any - value to be validated.
- returns: List<ValidationResult> - list with validation results.
validateAndThrowException
Validates the given value and throws a ValidationException if errors were found.
See ValidationException.throwExceptionIfNeeded
public
void validateAndThrowException(String traceId, Object value, boolean strict) throws ValidationException
- traceId: string - (optional) transaction id used to trace execution through the call chain.
- value: Object - value to be validated.
- strict: boolean - true to treat warnings as errors.
withRule
Adds validation rule to this schema. This method returns a reference to this exception to implement the Builder pattern to chain additional calls.
public
Schema withRule(IValidationRule rule)
- rule: IValidationRule - validation rule to be added.
- returns: Schema - validation schema.