Class ValidationMessage

java.lang.Object

com.networknt.schema.ValidationMessage

public class ValidationMessage
extends Object

The output format.

See Also:

• JSON Schema

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ValidationMessage.Builder
static class	ValidationMessage.BuilderSupport<S>

Field Summary

Fields

Modifier and Type	Field	Description
private final Object[]	arguments
private final String	code
private final Map<String,Object>	details
private final JsonNodePath	evaluationPath
private final JsonNodePath	instanceLocation
private final com.fasterxml.jackson.databind.JsonNode	instanceNode
private final String	messageKey
private final Supplier<String>	messageSupplier
private final String	property
private final SchemaLocation	schemaLocation
private final com.fasterxml.jackson.databind.JsonNode	schemaNode
private final String	type

Constructor Summary

Constructors

Constructor	Description
ValidationMessage(String type, String code, JsonNodePath evaluationPath, SchemaLocation schemaLocation, JsonNodePath instanceLocation, String property, Object[] arguments, Map<String,Object> details, String messageKey, Supplier<String> messageSupplier, com.fasterxml.jackson.databind.JsonNode instanceNode, com.fasterxml.jackson.databind.JsonNode schemaNode)

Method Summary

Modifier and Type	Method	Description
static ValidationMessage.Builder	builder()
boolean	equals(Object o)
Object[]	getArguments()
String	getCode()
Map<String,Object>	getDetails()
String	getError()	Gets the error.
JsonNodePath	getEvaluationPath()	The evaluation path is the set of keys, starting from the schema root, through which evaluation passes to reach the schema object that produced a specific result.
JsonNodePath	getInstanceLocation()	The instance location is the location of the JSON value within the root instance being validated.
com.fasterxml.jackson.databind.JsonNode	getInstanceNode()	Returns the instance node which was evaluated.
String	getMessage()	Gets the formatted error message.
String	getMessageKey()
String	getProperty()	Returns the property with the error.
SchemaLocation	getSchemaLocation()	The schema location is the canonical IRI of the schema object plus a JSON Pointer fragment indicating the subschema that produced a result.
com.fasterxml.jackson.databind.JsonNode	getSchemaNode()	Returns the schema node which was evaluated.
String	getType()
int	hashCode()
boolean	isValid()
String	toString()

Methods inherited from class Object

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

Field Details

type

private final String type

code

private final String code

evaluationPath

private final JsonNodePath evaluationPath

schemaLocation

private final SchemaLocation schemaLocation

instanceLocation

private final JsonNodePath instanceLocation

property

private final String property

arguments

private final Object[] arguments

messageKey

private final String messageKey

messageSupplier

private final Supplier<String> messageSupplier

details

private final Map<String,Object> details

instanceNode

private final com.fasterxml.jackson.databind.JsonNode instanceNode

schemaNode

private final com.fasterxml.jackson.databind.JsonNode schemaNode

Constructor Details

ValidationMessage

ValidationMessage(String type,
 String code,
 JsonNodePath evaluationPath,
 SchemaLocation schemaLocation,
 JsonNodePath instanceLocation,
 String property,
 Object[] arguments,
 Map<String,Object> details,
 String messageKey,
 Supplier<String> messageSupplier,
 com.fasterxml.jackson.databind.JsonNode instanceNode,
 com.fasterxml.jackson.databind.JsonNode schemaNode)

Method Details

getCode

public String getCode()

getInstanceLocation

public JsonNodePath getInstanceLocation()

The instance location is the location of the JSON value within the root instance being validated.

Returns:

The path to the input json

getEvaluationPath

public JsonNodePath getEvaluationPath()

The evaluation path is the set of keys, starting from the schema root, through which evaluation passes to reach the schema object that produced a specific result.

Returns:

the evaluation path

getSchemaLocation

public SchemaLocation getSchemaLocation()

The schema location is the canonical IRI of the schema object plus a JSON Pointer fragment indicating the subschema that produced a result. In contrast with the evaluation path, the schema location MUST NOT include by-reference applicators such as $ref or $dynamicRef.

Returns:

the schema location

getInstanceNode

public com.fasterxml.jackson.databind.JsonNode getInstanceNode()

Returns the instance node which was evaluated.

This corresponds with the instance location.

Returns:

the instance node

getSchemaNode

public com.fasterxml.jackson.databind.JsonNode getSchemaNode()

Returns the schema node which was evaluated.

This corresponds with the schema location.

Returns:

the schema node

getProperty

public String getProperty()

Returns the property with the error.

For instance, for the required validator the instance location does not contain the missing property name as the instance must refer to the input data.

Returns:

the property name

getArguments

public Object[] getArguments()

getDetails

public Map<String,Object> getDetails()

getMessage

public String getMessage()

Gets the formatted error message.

Returns:

the error message

getMessageKey

public String getMessageKey()

isValid

public boolean isValid()

getError

public String getError()

Gets the error.

Returns:

the error

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getType

public String getType()

builder

public static ValidationMessage.Builder builder()