Module dev.metaschema.core
Package dev.metaschema.core.model.validation

Interface IValidationFinding

All Known Implementing Classes:
ConstraintValidationFinding, JsonSchemaContentValidator.JsonValidationFinding, XmlSchemaContentValidator.XmlValidationFinding
public interface IValidationFinding
Provides information about an individual finding that is the result of a completed content validation.

  • Method Details

    • getIdentifier

      @Nullable String getIdentifier()
      Get the unique identifier for the finding.
      Returns:
      the identifier

    • getSeverity

      @NonNull IConstraint.Level getSeverity()
      Get the finding's severity.
      Returns:
      the severity

    • getKind

      @NonNull IValidationFinding.Kind getKind()
      Get the finding type.
      Returns:
      the finding type

    • getDocumentUri

      @Nullable URI getDocumentUri()
      Get the document's URI.
      Returns:
      the document's URI or null if it is not known

    • getLocation

      @Nullable IResourceLocation getLocation()
      Get the location in the associated resource associated with the finding.
      Returns:
      the location or null if no location is known

    • getPathKind

      @Nullable String getPathKind()
      Get the path expression type provided by the getPath() method.
      Returns:
      the path type identifier or null if unknown

    • getPath

      @Nullable String getPath()
      A format specific path to the finding in the source document.
      Returns:
      the path or null if unknown

    • getMessage

      @Nullable String getMessage()
      Get the finding message.
      Returns:
      the message or null if there is no message

    • getCause

      Throwable getCause()
      Get the exception associated with the finding.
      Returns:
      the Throwable or null if no thowable is associated with the finding