com.github.fge.jsonschema.keyword.syntax

Interface SyntaxChecker

All Known Implementing Classes:

AbstractSyntaxChecker, AdditionalSyntaxChecker, DefinitionsSyntaxChecker, DependenciesSyntaxChecker, DivisorSyntaxChecker, DraftV3DependenciesSyntaxChecker, DraftV3ItemsSyntaxChecker, DraftV3PropertiesSyntaxChecker, DraftV3TypeKeywordSyntaxChecker, DraftV4DependenciesSyntaxChecker, DraftV4ItemsSyntaxChecker, DraftV4PropertiesSyntaxChecker, DraftV4TypeSyntaxChecker, EnumSyntaxChecker, ExclusiveMaximumSyntaxChecker, ExclusiveMinimumSyntaxChecker, ExtendsSyntaxChecker, NotSyntaxChecker, PatternPropertiesSyntaxChecker, PatternSyntaxChecker, PositiveIntegerSyntaxChecker, RequiredSyntaxChecker, SchemaArraySyntaxChecker, SchemaMapSyntaxChecker, SchemaOrSchemaArraySyntaxChecker, TypeOnlySyntaxChecker, URISyntaxChecker

public interface SyntaxChecker

Interface for a syntax checker

This is a syntax checker for one keyword. As some keywords contain subschemas, a list of JsonPointer is also passed as an argument so that the checker can instruct the syntax processor to also check these paths after it is done.

Note that when a syntax checker is called on a schema, it is guaranteed that the keyword exists in the schema.

See Also:

SyntaxProcessor

Method Summary

Methods

Modifier and Type	Method and Description
void	checkSyntax(Collection<JsonPointer> pointers, ProcessingReport report, SchemaTree tree) Check the syntax for this keyword
EnumSet<NodeType>	getValidTypes()

Method Detail

getValidTypes

EnumSet<NodeType> getValidTypes()

checkSyntax

void checkSyntax(Collection<JsonPointer> pointers,
               ProcessingReport report,
               SchemaTree tree)
                 throws ProcessingException

Check the syntax for this keyword

Parameters:

pointers - the list of JSON Pointers to fill (see description)

report - the processing report to use

tree - the schema

Throws:

ProcessingException - an error is detected, and the report is configured to throw an exception on error.