org.eel.kitchen.jsonschema.main

Class ValidationReport

java.lang.Object

org.eel.kitchen.jsonschema.main.ValidationReport

public final class ValidationReport
extends Object

Validation report

It is a simple ListMultimap which associates a path into the validated instance (as a JsonPointer to a list of validation messages.

Field Summary

Fields

Modifier and Type	Field and Description
private ListMultimap<JsonPointer,String>	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
void	addMessage(String message) Add one message to the current path
void	addMessages(List<String> messages) Add a list of messages to the current path
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	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

Methods inherited from class java.lang.Object

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

Field Detail

ROOT

private static final JsonPointer ROOT

Root JSON Pointer (ie, #)

msgMap

private final ListMultimap<JsonPointer,String> msgMap

Message list

path

private JsonPointer path

The current path

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 void addMessage(String message)

Add one message to the current path

Parameters:

message - the message to add

addMessages

public void addMessages(List<String> messages)

Add a list of messages to the current path

Parameters:

messages - the list of messages

isSuccess

public boolean isSuccess()

Is this report a success?

Returns:

true if the message map is empty

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