org.eel.kitchen.jsonschema.syntax

Class AbstractSyntaxChecker

java.lang.Object

org.eel.kitchen.jsonschema.syntax.AbstractSyntaxChecker

All Implemented Interfaces:

SyntaxChecker

Direct Known Subclasses:

ContentEncodingSyntaxChecker, DivisorSyntaxChecker, DraftV3DependenciesSyntaxChecker, DraftV3ItemsSyntaxChecker, DraftV3PropertiesSyntaxChecker, DraftV3TypeKeywordSyntaxChecker, DraftV4DependenciesSyntaxChecker, DraftV4ItemsSyntaxChecker, DraftV4TypeSyntaxChecker, EnumSyntaxChecker, ExclusiveMaximumSyntaxChecker, ExclusiveMinimumSyntaxChecker, ExtendsSyntaxChecker, FragmentResolutionSyntaxChecker, LinksSyntaxChecker, MediaTypeSyntaxChecker, PatternPropertiesSyntaxChecker, PatternSyntaxChecker, PositiveIntegerSyntaxChecker, RequiredSyntaxChecker, SchemaArraySyntaxChecker, TypeOnlySyntaxChecker, URISyntaxChecker

public abstract class AbstractSyntaxChecker
extends Object
implements SyntaxChecker

Basic syntax checker

All other syntax checkers inherit from this class. Its only purpose is to check whether the type of the keyword's value is of the expected type(s). More advanced syntax checkers will override checkValue( Message.Builder, List, JsonNode) to further check the anatomy of this value.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	keyword

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	checkSyntax(Message.Builder msg, List<Message> messages, JsonNode schema) Check the syntax for this keyword
abstract void	checkValue(Message.Builder msg, List<Message> messages, JsonNode schema)

Methods inherited from class java.lang.Object

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

Field Detail

keyword

protected final String keyword

Constructor Detail

AbstractSyntaxChecker

protected AbstractSyntaxChecker(String keyword,
                     NodeType type,
                     NodeType... types)

Method Detail

checkSyntax

public final void checkSyntax(Message.Builder msg,
               List<Message> messages,
               JsonNode schema)

Description copied from interface: SyntaxChecker

Check the syntax for this keyword

When entering this function, the message template passed as an argument will have already been filled with the matching validation domain (here, Domain.SYNTAX) and the keyword.

Specified by:

checkSyntax in interface SyntaxChecker

Parameters:

msg - the validation message template

messages - message list to fill in the event of a failure

schema - schema to analyze

See Also:

Message

checkValue

public abstract void checkValue(Message.Builder msg,
              List<Message> messages,
              JsonNode schema)