org.everit.json.schema

Class ValidationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.everit.json.schema.ValidationException

All Implemented Interfaces:

Serializable

public class ValidationException
extends RuntimeException

Thrown by Schema subclasses on validation failure.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ValidationException(Class<?> expectedType, Object actualValue) Deprecated.
ValidationException(Schema violatedSchema, Class<?> expectedType, Object actualValue) Constructor.
ValidationException(Schema violatedSchema, String message) Constructor.
ValidationException(String message) Deprecated.

Method Summary

Modifier and Type	Method and Description
List<ValidationException>	getCausingExceptions()
String	getMessage()
String	getPointerToViolation() A JSON pointer denoting the part of the document which violates the schema.
Schema	getViolatedSchema()
ValidationException	prepend(String fragment) Creates a new ViolationException instance based on this one, but with changed JSON pointer.
ValidationException	prepend(String fragment, Schema violatedSchema) Creates a new ViolationException instance based on this one, but with changed JSON pointer and {link violated schema.
static void	throwFor(Schema rootFailingSchema, List<ValidationException> failures) Sort of static factory method.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ValidationException

@Deprecated
public ValidationException(Class<?> expectedType,
                                       Object actualValue)

Deprecated.

Deprecated, use ValidationException(Schema, Class<?>, Object) instead.

Parameters:

expectedType - the expected type

actualValue - the violating value

ValidationException

public ValidationException(Schema violatedSchema,
                           Class<?> expectedType,
                           Object actualValue)

Constructor.

Parameters:

violatedSchema - the schema instance which detected the schema violation

expectedType - the expected type

actualValue - the violating value

ValidationException

public ValidationException(Schema violatedSchema,
                           String message)

Constructor.

Parameters:

violatedSchema - the schema instance which detected the schema violation

message - the readable exception message

ValidationException

@Deprecated
public ValidationException(String message)

Deprecated.

Deprecated, use ValidationException(Schema, String) instead.

Parameters:

message - readable exception message

Method Detail

throwFor

public static void throwFor(Schema rootFailingSchema,
                            List<ValidationException> failures)

Sort of static factory method. It is used by ObjectSchema and ArraySchema to create ValidationExceptions, handling the case of multiple violations occuring during validation.

• If failures is empty, then it doesn't do anything
• If failures contains 1 exception instance, then that will be thrown
• Otherwise a new exception instance will be created, its violated schema will be rootFailingSchema, and its causing exceptions will be the failures list

Parameters:

rootFailingSchema - the schema which detected the failures

failures - list containing validation failures to be thrown by this method

getCausingExceptions

public List<ValidationException> getCausingExceptions()

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getPointerToViolation

public String getPointerToViolation()

A JSON pointer denoting the part of the document which violates the schema. It always points from the root of the document to the violating data fragment, therefore it always starts with #.

Returns:

the JSON pointer

getViolatedSchema

public Schema getViolatedSchema()

prepend

public ValidationException prepend(String fragment)

Creates a new ViolationException instance based on this one, but with changed JSON pointer.

Parameters:

fragment - the fragment of the JSON pointer to be prepended to existing pointers

Returns:

the new instance

prepend

public ValidationException prepend(String fragment,
                                   Schema violatedSchema)

Creates a new ViolationException instance based on this one, but with changed JSON pointer and {link violated schema.

Parameters:

fragment - the fragment of the JSON pointer to be prepended to existing pointers

violatedSchema - the violated schema, which may not be the same as getViolatedSchema()

Returns:

the new ViolationException instance