dev.harrel.jsonschema.Dialect Maven / Gradle / Ivy

Go to download

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

Library for JSON schema validation

There is a newer version: 1.8.1

package dev.harrel.jsonschema;

import java.util.Map;
import java.util.Set;

/**
 * {@code Dialect} interface is the main abstraction for a specific (possibly custom) JSON Schema dialects.
 */
public interface Dialect {
    /**
     * Specification version used by this dialect.
     * Different versions are basically a modes in which validator can run in.
     *
     * @return specification version
     */
    SpecificationVersion getSpecificationVersion();

    /**
     * Meta-schema URI against which all schemas will be validated,
     * unless there is a $schema keyword present.
     *
     * @return meta-schema URI
     */
    String getMetaSchema();

    /**
     * Core evaluator factory used by this dialect.
     *
     * @return evaluator factory
     */
    EvaluatorFactory getEvaluatorFactory();

    /**
     * All vocabulary URIs that are supported by this dialect. Actual implementation for vocabularies and keywords
     * should be provided by {@link Dialect#getEvaluatorFactory()}
     *
     * @return set of supported vocabularies
     */
    Set getSupportedVocabularies();

    /**
     * All vocabulary URIs that are considered required at all times. If $vocabulary keyword
     * does not include this vocabulary or sets it as optional, {@link VocabularyException} will be thrown.
     *
     * @return set of required vocabularies
     */
    Set getRequiredVocabularies();

    /**
     * Default $vocabulary keyword contents for this dialect. If meta-schema does not include
     * $vocabulary keyword this default will be used.
     *
     * @return default vocabulary object
     */
    Map getDefaultVocabularyObject();
}