org.eel.kitchen.jsonschema.report

Class ValidationReport

java.lang.Object

org.eel.kitchen.jsonschema.report.ValidationReport

public final class ValidationReport
extends Object

A validation report

A report is a map of Messages, with the path into the validated instance where the error occurred as a supplementary information.

You can retrieve messages either as a list of plain strings or JSON (either an object or an array).

See Also:

JsonSchema.validate(JsonNode)

Constructor Summary

Constructors

Constructor and Description
ValidationReport() Create a new validation report with ROOT as an instance path

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addMessage(Message message) Add one validation message to the report
void	addMessages(Collection<Message> messages) Add several validation messages to the report
JsonNode	asJsonArray() Return the list of validation messages as a JSON array
JsonNode	asJsonObject() Retrieve all messages as a JSON object
ValidationReport	copy() Make a copy of this validation report, with an empty message map and the current path.
List<String>	getMessages() Get a flat list of validation messages as strings
JsonPointer	getPath() Get the current path of this report
boolean	hasFatalError() Was there a fatal error during validation?
boolean	isSuccess() Is this report a success?
void	mergeWith(ValidationReport other) Merge with another validation report
void	setPath(JsonPointer path) Set the current path of this report
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationReport

public ValidationReport()

Create a new validation report with ROOT as an instance path

Method Detail

getPath

public JsonPointer getPath()

Get the current path of this report

Returns:

the path

setPath

public void setPath(JsonPointer path)

Set the current path of this report

Parameters:

path - the path

addMessage

public boolean addMessage(Message message)

Add one validation message to the report

The message will be added to the already existing list of messages for the current path (see getPath(), setPath(JsonPointer)).

Parameters:

message - the message

Returns:

true if the added message is fatal, or if fatal is already true

addMessages

public void addMessages(Collection<Message> messages)

Add several validation messages to the report

Parameters:

messages - the collection of messages

isSuccess

public boolean isSuccess()

Is this report a success?

Returns:

true if the message map is empty

hasFatalError

public boolean hasFatalError()

Was there a fatal error during validation?

This implementation currently considers that all URI resolution failures are fatal errors.

Returns:

true if a fatal error has been encountered

mergeWith

public void mergeWith(ValidationReport other)

Merge with another validation report

Note that if a fatal error has been encountered, only the message describing this fatal error will make it into the report. Other messages are discarded.

Parameters:

other - the report to merge with

copy

public ValidationReport copy()

Make a copy of this validation report, with an empty message map and the current path.

Returns:

the new report

getMessages

public List<String> getMessages()

Get a flat list of validation messages as strings

One message has the form:

     "/pointer/here": message here
 

The list is sorted by pointer.

Returns:

the list of messages

asJsonObject

public JsonNode asJsonObject()

Retrieve all messages as a JSON object

The retrieved JSON document is an object where:

• keys are string representations of JsonPointers,
• values are arrays of objects where each individual object is the JSON representation of one message.

Note: the returned JsonNode is mutable.

Returns:

a JSON object with all validation messages

See Also:

Message.toJsonNode()

asJsonArray

public JsonNode asJsonArray()

Return the list of validation messages as a JSON array

This method makes its best to order validation messages correctly.

Each message in the resulting array is a JSON object, with the contents of the Message and with an added member named path, which contains the path into the instance where the error has occurred (as a JsonPointer).

Returns:

a JSON array with all validation messages

See Also:

Message.toJsonNode()

toString

public String toString()

Overrides:

toString in class Object