org.eel.kitchen.jsonschema.report

Class Message

java.lang.Object

org.eel.kitchen.jsonschema.report.Message

public final class Message
extends Object

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.

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
boolean	equals(Object obj)
Domain	getDomain()
JsonNode	getInfo(String key)
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()

getInfo

public JsonNode getInfo(String key)

toJsonNode

public JsonNode toJsonNode()

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