Package dev.harrel.jsonschema

Class ValidatorFactory

java.lang.Object

dev.harrel.jsonschema.ValidatorFactory

public final class ValidatorFactory
extends Object

Configurable factory for Validator class. Provides methods for ad-hoc validation, which parse schema each time they are invoked.

See Also:

• Validator

Constructor Summary

Constructors

Constructor	Description
ValidatorFactory()

Method Summary

Modifier and Type	Method	Description
Validator	createValidator()	Creates new instance of Validator using current configuration.
Validator.Result	validate(JsonNode schemaNode, JsonNode instanceNode)	Validates JSON instance against schema.
Validator.Result	validate(JsonNode schemaNode, Object instanceProviderNode)	Validates JSON instance against schema.
Validator.Result	validate(JsonNode schemaNode, String rawInstance)	Validates JSON instance against schema.
Validator.Result	validate(Object schemaProviderNode, JsonNode instanceNode)	Validates JSON instance against schema.
Validator.Result	validate(Object schemaProviderNode, Object instanceProviderNode)	Validates JSON instance against schema.
Validator.Result	validate(Object schemaProviderNode, String rawInstance)	Validates JSON instance against schema.
Validator.Result	validate(String rawSchema, JsonNode instanceNode)	Validates JSON instance against schema.
Validator.Result	validate(String rawSchema, Object instanceProviderNode)	Validates JSON instance against schema.
Validator.Result	validate(String rawSchema, String rawInstance)	Validates JSON instance against schema.
ValidatorFactory	withDialect(Dialect dialect)	Sets Dialect.
ValidatorFactory	withDisabledSchemaValidation(boolean disabledSchemaValidation)	Disables schema validation against meta-schemas.
ValidatorFactory	withEvaluatorFactory(EvaluatorFactory evaluatorFactory)	Sets additional EvaluatorFactory to be used alongside with the core EvaluatorFactory provided by Dialect.
ValidatorFactory	withJsonNodeFactory(JsonNodeFactory jsonNodeFactory)	Sets JsonNodeFactory.
ValidatorFactory	withSchemaResolver(SchemaResolver schemaResolver)	Composes SchemaResolver with default schema resolver.

Methods inherited from class java.lang.Object

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

Constructor Details

ValidatorFactory

public ValidatorFactory()

Method Details

createValidator

public Validator createValidator()

Creates new instance of Validator using current configuration.

Returns:

new Validator instance

withDialect

public ValidatorFactory withDialect(Dialect dialect)

Sets Dialect. Provided default is Dialects.Draft2020Dialect.

Parameters:

dialect - Dialect to be used

Returns:

self

withEvaluatorFactory

public ValidatorFactory withEvaluatorFactory(EvaluatorFactory evaluatorFactory)

Sets additional EvaluatorFactory to be used alongside with the core EvaluatorFactory provided by Dialect. This is the best way to provide custom keyword support.

Parameters:

evaluatorFactory - EvaluatorFactory to be used

Returns:

self

withJsonNodeFactory

public ValidatorFactory withJsonNodeFactory(JsonNodeFactory jsonNodeFactory)

Sets JsonNodeFactory. Provided default is JacksonNode.Factory.

Parameters:

jsonNodeFactory - JsonNodeFactory to be used

Returns:

self

withSchemaResolver

public ValidatorFactory withSchemaResolver(SchemaResolver schemaResolver)

Composes SchemaResolver with default schema resolver. The default schema resolver resolves only official specification meta-schemas. Meta-schemas are loaded from classpath.

Parameters:

schemaResolver - SchemaResolver to be used

Returns:

self

See Also:

• SpecificationVersion

withDisabledSchemaValidation

public ValidatorFactory withDisabledSchemaValidation(boolean disabledSchemaValidation)

Disables schema validation against meta-schemas. This also disables vocabulary specific semantics. $schema keyword will be ignored.

Parameters:

disabledSchemaValidation - if schema validation should be disabled

Returns:

self

validate

public Validator.Result validate(String rawSchema,
 String rawInstance)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

rawSchema - string representation of schema JSON

rawInstance - string representation of instance JSON

Returns:

validation result

validate

public Validator.Result validate(Object schemaProviderNode,
 String rawInstance)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

schemaProviderNode - object representing schema JSON for currently set JsonNodeFactory. E.g. com.fasterxml.jackson.databind.JsonNode for default JsonNodeFactory (JacksonNode.Factory)

rawInstance - string representation of instance JSON

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(JsonNode schemaNode,
 String rawInstance)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

schemaNode - JsonNode schema JSON, which could be created via JsonNodeFactory

rawInstance - string representation of instance JSON

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(String rawSchema,
 Object instanceProviderNode)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

rawSchema - string representation of schema JSON

instanceProviderNode - object representing instance JSON for currently set JsonNodeFactory. E.g. com.fasterxml.jackson.databind.JsonNode for default JsonNodeFactory (JacksonNode.Factory)

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(Object schemaProviderNode,
 Object instanceProviderNode)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

schemaProviderNode - object representing schema JSON for currently set JsonNodeFactory. E.g. com.fasterxml.jackson.databind.JsonNode for default JsonNodeFactory (JacksonNode.Factory)

instanceProviderNode - object representing instance JSON for currently set JsonNodeFactory. E.g. com.fasterxml.jackson.databind.JsonNode for default JsonNodeFactory (JacksonNode.Factory)

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(JsonNode schemaNode,
 Object instanceProviderNode)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

schemaNode - JsonNode schema JSON, which could be created via JsonNodeFactory

instanceProviderNode - object representing instance JSON for currently set JsonNodeFactory. E.g. com.fasterxml.jackson.databind.JsonNode for default JsonNodeFactory (JacksonNode.Factory)

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(String rawSchema,
 JsonNode instanceNode)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

rawSchema - string representation of schema JSON

instanceNode - JsonNode instance JSON, which could be created via JsonNodeFactory

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(Object schemaProviderNode,
 JsonNode instanceNode)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

schemaProviderNode - object representing schema JSON for currently set JsonNodeFactory. E.g. com.fasterxml.jackson.databind.JsonNode for default JsonNodeFactory (JacksonNode.Factory)

instanceNode - JsonNode instance JSON, which could be created via JsonNodeFactory

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(JsonNode schemaNode,
 JsonNode instanceNode)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

schemaNode - JsonNode schema JSON, which could be created via JsonNodeFactory

instanceNode - JsonNode instance JSON, which could be created via JsonNodeFactory

Returns:

validation result

See Also:

• validate(String, String)