org.eel.kitchen.jsonschema.syntax

Interface SyntaxChecker

All Known Implementing Classes:

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

public interface SyntaxChecker

Interface implemented by all syntax checkers

There exists one syntax checker per supported schema keyword. For the recall, their role is to ensure the keyword values are well formed, so as to ease the job of the associated keyword validator.

You have the option to directly implement this interface, however you're probably better off extending AbstractSyntaxChecker instead.

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

Method Detail

checkSyntax

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

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.

Parameters:

msg - the validation message template

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

schema - schema to analyze

See Also:

Message