Package com.networknt.schema

Interface JsonValidator

All Superinterfaces:

JsonSchemaWalker

All Known Implementing Classes:

AbstractJsonValidator, AdditionalPropertiesValidator, AllOfValidator, AnyOfValidator, BaseJsonValidator, ConstValidator, ContainsValidator, DateTimeValidator, DependenciesValidator, DependentRequired, DependentSchemas, EmailValidator, EnumValidator, ExclusiveMaximumValidator, ExclusiveMinimumValidator, FalseValidator, FormatValidator, IfValidator, ItemsValidator, JsonSchema, MaximumValidator, MaxItemsValidator, MaxLengthValidator, MaxPropertiesValidator, MinimumValidator, MinItemsValidator, MinLengthValidator, MinPropertiesValidator, MultipleOfValidator, NotAllowedValidator, NotValidator, OneOfValidator, PatternPropertiesValidator, PatternValidator, PrefixItemsValidator, PropertiesValidator, PropertyNamesValidator, ReadOnlyValidator, RefValidator, RequiredValidator, TrueValidator, TypeValidator, UnEvaluatedPropertiesValidator, UnionTypeValidator, UniqueItemsValidator, UUIDValidator

public interface JsonValidator
extends JsonSchemaWalker

Standard json validator interface, implemented by all validators and JsonSchema.

Field Summary

Fields

Modifier and Type	Field	Description
static String	AT_ROOT

Method Summary

Modifier and Type	Method	Description
default void	preloadJsonSchema()	In case the JsonValidator has a related JsonSchema or several ones, calling preloadJsonSchema will actually load the schema document(s) eagerly.
Set<ValidationMessage>	validate(com.fasterxml.jackson.databind.JsonNode rootNode)	Validate the given root JsonNode, starting at the root of the data path.
Set<ValidationMessage>	validate(com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.JsonNode rootNode, String at)	Validate the given JsonNode, the given node is the child node of the root node at given data path.

Methods inherited from interface com.networknt.schema.walk.JsonSchemaWalker

walk

Field Detail

AT_ROOT

static final String AT_ROOT

See Also:

Constant Field Values

Method Detail

validate

Set<ValidationMessage> validate(com.fasterxml.jackson.databind.JsonNode rootNode)

Validate the given root JsonNode, starting at the root of the data path.

Parameters:

rootNode - JsonNode

Returns:

A list of ValidationMessage if there is any validation error, or an empty list if there is no error.

validate

Set<ValidationMessage> validate(com.fasterxml.jackson.databind.JsonNode node,
                                com.fasterxml.jackson.databind.JsonNode rootNode,
                                String at)

Validate the given JsonNode, the given node is the child node of the root node at given data path.

Parameters:

node - JsonNode

rootNode - JsonNode

at - String

Returns:

A list of ValidationMessage if there is any validation error, or an empty list if there is no error.

preloadJsonSchema

default void preloadJsonSchema()
                        throws JsonSchemaException

In case the JsonValidator has a related JsonSchema or several ones, calling preloadJsonSchema will actually load the schema document(s) eagerly.

Throws:

JsonSchemaException - (a RuntimeException) in case the JsonSchema or nested schemas are invalid (like $ref not resolving)

Since:

1.0.54