Class ValidationMessage


  • public class ValidationMessage
    extends java.lang.Object
    The output format.
    See Also:
    JSON Schema
    • Field Detail

      • type

        private final java.lang.String type
      • code

        private final java.lang.String code
      • instanceLocation

        private final JsonNodePath instanceLocation
      • property

        private final java.lang.String property
      • arguments

        private final java.lang.Object[] arguments
      • messageKey

        private final java.lang.String messageKey
      • messageSupplier

        private final java.util.function.Supplier<java.lang.String> messageSupplier
      • details

        private final java.util.Map<java.lang.String,​java.lang.Object> details
      • instanceNode

        private final com.fasterxml.jackson.databind.JsonNode instanceNode
      • schemaNode

        private final com.fasterxml.jackson.databind.JsonNode schemaNode
    • Constructor Detail

      • ValidationMessage

        ValidationMessage​(java.lang.String type,
                          java.lang.String code,
                          JsonNodePath evaluationPath,
                          SchemaLocation schemaLocation,
                          JsonNodePath instanceLocation,
                          java.lang.String property,
                          java.lang.Object[] arguments,
                          java.util.Map<java.lang.String,​java.lang.Object> details,
                          java.lang.String messageKey,
                          java.util.function.Supplier<java.lang.String> messageSupplier,
                          com.fasterxml.jackson.databind.JsonNode instanceNode,
                          com.fasterxml.jackson.databind.JsonNode schemaNode)
    • Method Detail

      • getCode

        public java.lang.String getCode()
      • getInstanceLocation

        public JsonNodePath getInstanceLocation()
        The instance location is the location of the JSON value within the root instance being validated.
        Returns:
        The path to the input json
      • getEvaluationPath

        public JsonNodePath getEvaluationPath()
        The evaluation path is the set of keys, starting from the schema root, through which evaluation passes to reach the schema object that produced a specific result.
        Returns:
        the evaluation path
      • getSchemaLocation

        public SchemaLocation getSchemaLocation()
        The schema location is the canonical IRI of the schema object plus a JSON Pointer fragment indicating the subschema that produced a result. In contrast with the evaluation path, the schema location MUST NOT include by-reference applicators such as $ref or $dynamicRef.
        Returns:
        the schema location
      • getInstanceNode

        public com.fasterxml.jackson.databind.JsonNode getInstanceNode()
        Returns the instance node which was evaluated.

        This corresponds with the instance location.

        Returns:
        the instance node
      • getSchemaNode

        public com.fasterxml.jackson.databind.JsonNode getSchemaNode()
        Returns the schema node which was evaluated.

        This corresponds with the schema location.

        Returns:
        the schema node
      • getProperty

        public java.lang.String getProperty()
        Returns the property with the error.

        For instance, for the required validator the instance location does not contain the missing property name as the instance must refer to the input data.

        Returns:
        the property name
      • getArguments

        public java.lang.Object[] getArguments()
      • getDetails

        public java.util.Map<java.lang.String,​java.lang.Object> getDetails()
      • getMessage

        public java.lang.String getMessage()
        Gets the formatted error message.
        Returns:
        the error message
      • getMessageKey

        public java.lang.String getMessageKey()
      • isValid

        public boolean isValid()
      • getError

        public java.lang.String getError()
        Gets the error.
        Returns:
        the error
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • getType

        public java.lang.String getType()