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

Internally, it uses a ListMultimap where:

• keys are path into the validated instance (as JsonPointers),
• values are (a list of) ValidationMessages.

You can retrieve messages either as a list of plain strings (ordered by instance path) or as JSON (ie, a JsonNode).

See Also:

JsonSchema.validate(JsonNode)

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	fatal
private ListMultimap<JsonPointer,ValidationMessage>	msgMap Message list
private JsonPointer	path The current path
private static JsonPointer	ROOT Root JSON Pointer (ie, #)

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addMessage(ValidationMessage message) Add one validation message to the report
void	addMessages(Collection<ValidationMessage> messages) Add several validation messages to the report
JsonNode	asJsonNode() Retrieve all messages as a JsonNode
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
JsonPointer	getPath() Get the current path of this report
boolean	hasFatalError()
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
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ROOT

private static final JsonPointer ROOT

Root JSON Pointer (ie, #)

msgMap

private final ListMultimap<JsonPointer,ValidationMessage> msgMap

Message list

path

private JsonPointer path

The current path

fatal

private boolean fatal

Constructor Detail

ValidationReport

public ValidationReport()

Create a new validation report with ROOT as an instance path

ValidationReport

private ValidationReport(JsonPointer path)

Create a new validation report with an arbitraty path

Parameters:

path - the JSON Pointer

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(ValidationMessage message)

Add one validation message to the report

Parameters:

message - the message

Returns:

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

addMessages

public void addMessages(Collection<ValidationMessage> messages)

Add several validation messages to the report

Parameters:

messages - the collection of messages

size

public int size()

isSuccess

public boolean isSuccess()

Is this report a success?

Returns:

true if the message map is empty

hasFatalError

public boolean hasFatalError()

mergeWith

public void mergeWith(ValidationReport other)

Merge with another validation report

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

One message has the form:

     #/pointer/here: message here
 

The list is sorted by pointer.

Returns:

the list of messages

asJsonNode

public JsonNode asJsonNode()

Retrieve all messages as a JsonNode

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.

Returns:

a JSON document with all validation messages

See Also:

ValidationMessage.toJsonNode()

toString

public String toString()

Overrides:

toString in class Object