Package com.networknt.schema

Class IfValidator

java.lang.Object

com.networknt.schema.ValidationMessageHandler

com.networknt.schema.BaseJsonValidator

com.networknt.schema.IfValidator

All Implemented Interfaces:

JsonValidator, JsonSchemaWalker

public class IfValidator
extends BaseJsonValidator

JsonValidator for if.

Nested Class Summary

Nested classes/interfaces inherited from class com.networknt.schema.BaseJsonValidator

BaseJsonValidator.JsonNodePathJsonPath, BaseJsonValidator.JsonNodePathJsonPointer, BaseJsonValidator.JsonNodePathLegacy

Field Summary

Fields inherited from class com.networknt.schema.BaseJsonValidator

schemaNode, suppressSubSchemaRetrieval, validationContext

Fields inherited from class com.networknt.schema.ValidationMessageHandler

customErrorMessagesEnabled, errorMessage, errorMessageType, evaluationParentSchema, evaluationPath, keyword, messageSource, parentSchema, schemaLocation

Constructor Summary

Constructors

Constructor	Description
IfValidator(SchemaLocation schemaLocation, JsonNodePath evaluationPath, com.fasterxml.jackson.databind.JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext)

Method Summary

Modifier and Type	Method	Description
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(ExecutionContext executionContext, com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.JsonNode rootNode, JsonNodePath instanceLocation)	Validate the given JsonNode, the given node is the child node of the root node at given data path.
Set<ValidationMessage>	walk(ExecutionContext executionContext, com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.JsonNode rootNode, JsonNodePath instanceLocation, boolean shouldValidateSchema)	This is default implementation of walk method.

Methods inherited from class com.networknt.schema.BaseJsonValidator

atRoot, checkDiscriminatorMatch, collectAnnotations, collectAnnotations, debug, equals, fetchSubSchemaNode, getEvaluationParentSchema, getEvaluationPath, getKeyword, getNodeFieldType, getParentSchema, getSchemaLocation, getSchemaNode, hasAdjacentKeywordInEvaluationPath, message, preloadJsonSchemas, putAnnotation, registerAndMergeDiscriminator, toString, validate

Methods inherited from class com.networknt.schema.ValidationMessageHandler

getErrorCodeKey, getErrorMessage, getErrorMessageType, getMessageNode, parseErrorCode, updateErrorMessageType, updateKeyword, updateValidatorType

Methods inherited from class java.lang.Object

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

Constructor Detail

IfValidator

public IfValidator(SchemaLocation schemaLocation,
                   JsonNodePath evaluationPath,
                   com.fasterxml.jackson.databind.JsonNode schemaNode,
                   JsonSchema parentSchema,
                   ValidationContext validationContext)

Method Detail

validate

public Set<ValidationMessage> validate(ExecutionContext executionContext,
                                       com.fasterxml.jackson.databind.JsonNode node,
                                       com.fasterxml.jackson.databind.JsonNode rootNode,
                                       JsonNodePath instanceLocation)

Description copied from interface: JsonValidator

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

Parameters:

executionContext - ExecutionContext

node - JsonNode

rootNode - JsonNode

instanceLocation - JsonNodePath

Returns:

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

preloadJsonSchema

public void preloadJsonSchema()

Description copied from interface: JsonValidator

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

walk

public Set<ValidationMessage> walk(ExecutionContext executionContext,
                                   com.fasterxml.jackson.databind.JsonNode node,
                                   com.fasterxml.jackson.databind.JsonNode rootNode,
                                   JsonNodePath instanceLocation,
                                   boolean shouldValidateSchema)

Description copied from interface: JsonValidator

This is default implementation of walk method. Its job is to call the validate method if shouldValidateSchema is enabled.

Parameters:

executionContext - ExecutionContext

node - JsonNode

rootNode - JsonNode

instanceLocation - JsonNodePath

shouldValidateSchema - boolean

Returns:

a set of validation messages if shouldValidateSchema is true.