ValidationException

Errors in schema validation.

Extends: BadRequestException

Description

The ValidationException is used to define errors in a schema validation.

Important points

  • Validation errors are usually generated based in ValidationResult.
  • If using strict mode, warnings will also raise validation exceptions.

Constructors

Creates a new instance of validation exception and assigns its values.

ValidationException(String? correlationId, [String? message, List<ValidationResult>? results])

  • correlationId: String? - (optional) unique transaction id used to trace execution through the call chain.
  • message: String? - (optional) human-readable description of the error.
  • results: List<ValidationResult>? - (optional) list of validation results.

Static methods

composeMessage

Composes human readable error message based on validation results.

static String composeMessage(List<ValidationResult>? results)

  • results: List<ValidationResult> - list of validation results.
  • returns: String - composed error message.

fromResults

Creates a new ValidationException based on errors in validation results. If validation results have no errors, then null is returned.

static ValidationException? fromResults(String? correlationId, List<ValidationResult> results, bool strict)

  • correlationId: String? - (optional) transaction id used to trace execution through the call chain.
  • results: List<ValidationResult> - list of validation results that may contain errors.
  • strict: bool - true to treat warnings as errors.
  • returns: ValidationException? - newly created ValidationException or null if no errors were found.

throwExceptionIfNeeded

Throws ValidationException based on errors in validation results. If validation results have no errors, then no exception is thrown.

static void throwExceptionIfNeeded(String? correlationId, List<ValidationResult> results, bool strict)

  • correlationId: String? - (optional) transaction id used to trace execution through the call chain.
  • results: List<ValidationResult> - list of validation results that may contain errors.
  • strict: bool - true to treat warnings as errors.

See also