com.github.fge.jsonschema.report

Class Message

java.lang.Object

com.github.fge.jsonschema.report.Message

All Implemented Interfaces:

Comparable<Message>

public final class Message
extends Object
implements Comparable<Message>

One validation message

A validation message consists of three mandatory fields and optional information. The three mandatory fields are:

• the validation domain (see Domain);
• the associated keyword;
• the validation message.

Supplementary information can be added via the different .addInfo() methods.

Example of the JSON representation of one message:

     {
         "domain": "validation",
         "keyword": "maxItems",
         "message": "too many elements in array",
         "maxItems": 4,
         "found": 5
     }
 

You cannot instantiate this class directly: use Domain.newMessage() for that.

This class is immutable.

See Also:

Message.Builder, ValidationReport

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.Builder Builder class for a Message

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Message o) Implementation of Comparable for this class
boolean	equals(Object obj)
Domain	getDomain()
String	getKeyword()
String	getMessage()
int	hashCode()
boolean	isFatal()
JsonNode	toJsonNode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getDomain

public Domain getDomain()

getKeyword

public String getKeyword()

getMessage

public String getMessage()

isFatal

public boolean isFatal()

toJsonNode

public JsonNode toJsonNode()

compareTo

public int compareTo(Message o)

Implementation of Comparable for this class

The compared fields are the three mandatory parameters. Note that whether the message is fatal has no influence here, since if a message is fatal it will be the only reported message.

Specified by:

compareTo in interface Comparable<Message>

Parameters:

o - the message to compare to

Returns:

the result of the comparison

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object