org.eel.kitchen.jsonschema.keyword

Class KeywordValidator

java.lang.Object

org.eel.kitchen.jsonschema.keyword.KeywordValidator

Direct Known Subclasses:

AbstractTypeKeywordValidator, AdditionalItemsKeywordValidator, AdditionalPropertiesKeywordValidator, DraftV3DependenciesKeywordValidator, DraftV3PropertiesKeywordValidator, DraftV4DependenciesKeywordValidator, DraftV4TypeKeywordValidator, EnumKeywordValidator, Example9.DivisorsKeywordValidator, ExtendsKeywordValidator, FormatKeywordValidator, NotKeywordValidator, NumericKeywordValidator, PatternKeywordValidator, PositiveIntegerKeywordValidator, RequiredKeywordValidator, SchemaArrayKeywordValidator, UniqueItemsKeywordValidator

public abstract class KeywordValidator
extends Object

Base class for a schema keyword validator

In the processing order, a keyword validator is only called after the schema has been deemed syntactically valid: this is why it is practically a requirement that if you create a new validating keyword, you pair it with a SyntaxChecker. The constructor will be all the more simple as a result.

A keyword only takes effect for a certain number of JSON instance types: if the instance to validate is not among these types, validation succeeds.

Two other abstract classes exist which you may want to extend instead of this one, depending on your needs:

• NumericKeywordValidator, for validating numeric instances;
• PositiveIntegerKeywordValidator, for keywords accepting only a positive integer as an argument (to be paired with PositiveIntegerSyntaxChecker).

Field Summary

Fields

Modifier and Type	Field and Description
protected String	keyword The keyword

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeywordValidator(String keyword, NodeType... types) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	alwaysTrue()
protected Message.Builder	newMsg() Create a new validation message template
abstract String	toString()
protected abstract void	validate(ValidationContext context, ValidationReport report, JsonNode instance) Method which all keyword validators must implement
void	validateInstance(ValidationContext context, ValidationReport report, JsonNode instance) Main validation function

Methods inherited from class java.lang.Object

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

Field Detail

keyword

protected final String keyword

The keyword

Constructor Detail

KeywordValidator

protected KeywordValidator(String keyword,
                NodeType... types)

Constructor

Parameters:

types - the types validated by this keyword

Method Detail

validateInstance

public final void validateInstance(ValidationContext context,
                    ValidationReport report,
                    JsonNode instance)

Main validation function

Its only role is to check whether the instance type is recognized by this keyword. If so, it calls validate(ValidationContext, ValidationReport, JsonNode).

Parameters:

context - the context

report - the validation report

instance - the instance to validate

validate

protected abstract void validate(ValidationContext context,
            ValidationReport report,
            JsonNode instance)

Method which all keyword validators must implement

Parameters:

context - the context

report - the validation report

instance - the instance to validate

newMsg

protected final Message.Builder newMsg()

Create a new validation message template

Use this class when you want to report errors. It will have filled the message with the correct domain (Domain.VALIDATION) and keyword.

Returns:

a message builder

See Also:

Message

alwaysTrue

public boolean alwaysTrue()

toString

public abstract String toString()

Overrides:

toString in class Object