Module json_values
Package jsonvalues.spec

Class SpecError

java.lang.Object
jsonvalues.spec.SpecError
public final class SpecError extends Object
The `SpecError` class represents an error that occurs during the validation of a JSON value against a specification. It encapsulates information about the error, including the path where the error occurred, the error code, and the value that triggered the error.

json-values and json-specs in particular, uses `SpecError` instances to report validation errors when a JSON value does not conform to the specified rules and constraints.

Instances of this class are immutable and provide methods for creating and working with validation errors.

The `SpecError` class offers the following key functionality: - Generating a human-readable string representation of the error for debugging and logging purposes. - Implementing equality and hash code methods to compare error instances.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final ERROR_CODE
    errorCode
    The error code indicating the type of validation error.
    final JsPath
    path
    The path where the error occurred within the JSON structure.
    final JsValue
    value
    The JSON value that triggered the error.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
    Checks whether this `SpecError` instance is equal to another object.
    int
    hashCode()
    Computes the hash code of this `SpecError` instance.
    String
    toString()
    Returns a human-readable string representation of the `SpecError` instance.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • path

      public final JsPath path
      The path where the error occurred within the JSON structure.

    • errorCode

      public final ERROR_CODE errorCode
      The error code indicating the type of validation error.

    • value

      public final JsValue value
      The JSON value that triggered the error.

  • Method Details

    • toString

      public String toString()
      Returns a human-readable string representation of the `SpecError` instance.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the error, including path, error code, and value.

    • equals

      public boolean equals(Object o)
      Checks whether this `SpecError` instance is equal to another object.
      Overrides:
      equals in class Object
      Parameters:
      o - The object to compare to this `SpecError`.
      Returns:
      `true` if the objects are equal, `false` otherwise.

    • hashCode

      public int hashCode()
      Computes the hash code of this `SpecError` instance.
      Overrides:
      hashCode in class Object
      Returns:
      The hash code of the error instance based on its components.