org.eel.kitchen.jsonschema.syntax.SyntaxChecker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of json-schema-validator Show documentation

A Java implementation of the JSON Schema specification

There is a newer version: 1.5.2

Show newest version

package org.eel.kitchen.jsonschema.syntax;

import com.fasterxml.jackson.databind.JsonNode;
import org.eel.kitchen.jsonschema.report.Domain;
import org.eel.kitchen.jsonschema.report.Message;

import java.util.List;

/**
 * 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 {@link AbstractSyntaxChecker} instead.
 */
public 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, {@link Domain#SYNTAX}) and the keyword.
     *
     * @see Message
     *
     * @param msg the validation message template
     * @param messages message list to fill in the event of a failure
     * @param schema schema to analyze
     */
    void checkSyntax(final Message.Builder msg, final List messages,
        final JsonNode schema);
}