Refactor dialect and add dialects

Author: justin-tay

src/main/java/com/networknt/schema/DefaultJsonMetaSchemaFactory.java

@@ -20,6 +20,7 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.networknt.schema.Specification.Version;
+import com.networknt.schema.dialect.Dialect;
 
 /**
  * Default {@link JsonMetaSchemaFactory}.
@@ -30,7 +31,6 @@ public Dialect getMetaSchema(String iri, JsonSchemaFactory schemaFactory, Schema
         // Is it a well-known dialect?
         return Specification.Version.fromDialectId(iri)
                 .map(JsonSchemaFactory::checkVersion)
-                .map(JsonSchemaVersion::getInstance)
                 .orElseGet(() -> {
                     // Custom meta schema
                     return loadMetaSchema(iri, schemaFactory, config);

src/main/java/com/networknt/schema/DisallowUnknownJsonMetaSchemaFactory.java

@@ -15,6 +15,8 @@
  */
 package com.networknt.schema;
 
+import com.networknt.schema.dialect.Dialect;
+
 /**
  * A {@link JsonMetaSchemaFactory} that does not meta-schemas that aren't
  * explicitly configured in the {@link JsonSchemaFactory}.

src/main/java/com/networknt/schema/JsonMetaSchemaFactory.java

@@ -15,6 +15,8 @@
  */
 package com.networknt.schema;
 
+import com.networknt.schema.dialect.Dialect;
+
 /**
  * Factory for {@link Dialect}.
  */

src/main/java/com/networknt/schema/JsonSchemaFactory.java

@@ -19,6 +19,9 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.networknt.schema.Specification.Version;
+import com.networknt.schema.dialect.Dialect;
+import com.networknt.schema.dialect.DialectId;
+import com.networknt.schema.dialect.Dialects;
 import com.networknt.schema.resource.DefaultSchemaLoader;
 import com.networknt.schema.resource.SchemaLoader;
 import com.networknt.schema.resource.SchemaLoaders;
@@ -265,10 +268,9 @@ public static JsonSchemaFactory getInstance(Specification.Version versionFlag) {
      */
     public static JsonSchemaFactory getInstance(Specification.Version versionFlag,
             Consumer<JsonSchemaFactory.Builder> customizer) {
-        JsonSchemaVersion jsonSchemaVersion = checkVersion(versionFlag);
-        Dialect metaSchema = jsonSchemaVersion.getInstance();
-        JsonSchemaFactory.Builder builder = builder().defaultMetaSchemaIri(metaSchema.getIri())
-                .metaSchema(metaSchema);
+        Dialect dialect = checkVersion(versionFlag);
+        JsonSchemaFactory.Builder builder = builder().defaultMetaSchemaIri(dialect.getIri())
+                .metaSchema(dialect);
         if (customizer != null) {
             customizer.accept(builder);
         }
@@ -280,18 +282,18 @@ public static JsonSchemaFactory getInstance(Specification.Version versionFlag,
      * <p>
      * This throws an {@link IllegalArgumentException} for an unsupported value.
      * 
-     * @param versionFlag the schema dialect
+     * @param version the schema specification version
      * @return the version
      */
-    public static JsonSchemaVersion checkVersion(Specification.Version versionFlag){
-        if (null == versionFlag) return null;
-        switch (versionFlag) {
-            case DRAFT_2020_12: return new Version202012();
-            case DRAFT_2019_09: return new Version201909();
-            case DRAFT_7: return new Version7();
-            case DRAFT_6: return new Version6();
-            case DRAFT_4: return new Version4();
-            default: throw new IllegalArgumentException("Unsupported value" + versionFlag);
+    public static Dialect checkVersion(Specification.Version version){
+        if (null == version) return null;
+        switch (version) {
+            case DRAFT_2020_12: return Dialects.getDraft202012();
+            case DRAFT_2019_09: return Dialects.getDraft201909();
+            case DRAFT_7: return Dialects.getDraft7();
+            case DRAFT_6: return Dialects.getDraft6();
+            case DRAFT_4: return Dialects.getDraft4();
+            default: throw new IllegalArgumentException("Unsupported value" + version);
         }
     }
 
@@ -384,16 +386,16 @@ private JsonSchema doCreate(ValidationContext validationContext, SchemaLocation
      * @return the validation context to use
      */
     private ValidationContext withMetaSchema(ValidationContext validationContext, JsonNode schemaNode) {
-        Dialect metaSchema = getMetaSchema(schemaNode, validationContext.getConfig());
-        if (metaSchema != null && !metaSchema.getIri().equals(validationContext.getMetaSchema().getIri())) {
+        Dialect dialect = getMetaSchema(schemaNode, validationContext.getConfig());
+        if (dialect != null && !dialect.getIri().equals(validationContext.getMetaSchema().getIri())) {
             SchemaValidatorsConfig config = validationContext.getConfig();
-            if (metaSchema.getKeywords().containsKey("discriminator") && !config.isDiscriminatorKeywordEnabled()) {
+            if (dialect.getKeywords().containsKey("discriminator") && !config.isDiscriminatorKeywordEnabled()) {
                 config = SchemaValidatorsConfig.builder(config)
                         .discriminatorKeywordEnabled(true)
                         .nullableKeywordEnabled(true)
                         .build();
             }
-            return new ValidationContext(metaSchema, validationContext.getJsonSchemaFactory(), config,
+            return new ValidationContext(dialect, validationContext.getJsonSchemaFactory(), config,
                     validationContext.getSchemaReferences(), validationContext.getSchemaResources(),
                     validationContext.getDynamicAnchors());
         }

src/main/java/com/networknt/schema/JsonSchemaVersion.java

@@ -15,6 +15,8 @@
  */
 package com.networknt.schema;
 
+import com.networknt.schema.dialect.Dialect;
+
 /**
  * Json schema version.
  */

src/main/java/com/networknt/schema/Specification.java

@@ -17,6 +17,8 @@
 
 import java.util.Optional;
 
+import com.networknt.schema.dialect.DialectId;
+
 /**
  * The JSON Schema specification which defines the standard dialects.
  */

src/main/java/com/networknt/schema/ValidationContext.java

@@ -22,31 +22,32 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.networknt.schema.Specification.Version;
+import com.networknt.schema.dialect.Dialect;
 import com.networknt.schema.keyword.KeywordValidator;
 
 public class ValidationContext {
-    private final Dialect metaSchema;
+    private final Dialect dialect;
     private final JsonSchemaFactory jsonSchemaFactory;
     private final SchemaValidatorsConfig config;
     private final ConcurrentMap<String, JsonSchema> schemaReferences;
     private final ConcurrentMap<String, JsonSchema> schemaResources;
     private final ConcurrentMap<String, JsonSchema> dynamicAnchors;
 
-    public ValidationContext(Dialect metaSchema,
+    public ValidationContext(Dialect dialect,
                              JsonSchemaFactory jsonSchemaFactory, SchemaValidatorsConfig config) {
-        this(metaSchema, jsonSchemaFactory, config, new ConcurrentHashMap<>(), new ConcurrentHashMap<>(), new ConcurrentHashMap<>());
+        this(dialect, jsonSchemaFactory, config, new ConcurrentHashMap<>(), new ConcurrentHashMap<>(), new ConcurrentHashMap<>());
     }
 
-    public ValidationContext(Dialect metaSchema, JsonSchemaFactory jsonSchemaFactory,
+    public ValidationContext(Dialect dialect, JsonSchemaFactory jsonSchemaFactory,
             SchemaValidatorsConfig config, ConcurrentMap<String, JsonSchema> schemaReferences,
             ConcurrentMap<String, JsonSchema> schemaResources, ConcurrentMap<String, JsonSchema> dynamicAnchors) {
-        if (metaSchema == null) {
+        if (dialect == null) {
             throw new IllegalArgumentException("JsonMetaSchema must not be null");
         }
         if (jsonSchemaFactory == null) {
             throw new IllegalArgumentException("JsonSchemaFactory must not be null");
         }
-        this.metaSchema = metaSchema;
+        this.dialect = dialect;
         this.jsonSchemaFactory = jsonSchemaFactory;
         // The deprecated SchemaValidatorsConfig constructor needs to remain until removed
         this.config = config == null ? new SchemaValidatorsConfig() : config;
@@ -61,11 +62,11 @@ public JsonSchema newSchema(SchemaLocation schemaLocation, JsonNodePath evaluati
 
     public KeywordValidator newValidator(SchemaLocation schemaLocation, JsonNodePath evaluationPath,
             String keyword /* keyword */, JsonNode schemaNode, JsonSchema parentSchema) {
-        return this.metaSchema.newValidator(this, schemaLocation, evaluationPath, keyword, schemaNode, parentSchema);
+        return this.dialect.newValidator(this, schemaLocation, evaluationPath, keyword, schemaNode, parentSchema);
     }
 
     public String resolveSchemaId(JsonNode schemaNode) {
-        return this.metaSchema.readId(schemaNode);
+        return this.dialect.readId(schemaNode);
     }
 
     public JsonSchemaFactory getJsonSchemaFactory() {
@@ -104,10 +105,10 @@ public ConcurrentMap<String, JsonSchema> getDynamicAnchors() {
     }
 
     public Dialect getMetaSchema() {
-        return this.metaSchema;
+        return this.dialect;
     }
 
     public Optional<Version> activeDialect() {
-        return Optional.of(this.metaSchema.getSpecification());
+        return Optional.of(this.dialect.getSpecification());
     }
 }

…n/java/com/networknt/schema/Dialect.java …om/networknt/schema/dialect/Dialect.javasrc/main/java/com/networknt/schema/Dialect.java renamed to src/main/java/com/networknt/schema/dialect/Dialect.java src/main/java/com/networknt/schema/Dialect.java renamed to src/main/java/com/networknt/schema/dialect/Dialect.java

@@ -14,9 +14,21 @@
  * limitations under the License.
  */
 
-package com.networknt.schema;
+package com.networknt.schema.dialect;
 
 import com.fasterxml.jackson.databind.JsonNode;
+import com.networknt.schema.Error;
+import com.networknt.schema.Format;
+import com.networknt.schema.InvalidSchemaException;
+import com.networknt.schema.JsonNodePath;
+import com.networknt.schema.JsonSchema;
+import com.networknt.schema.JsonSchemaException;
+import com.networknt.schema.SchemaLocation;
+import com.networknt.schema.Specification;
+import com.networknt.schema.ValidationContext;
+import com.networknt.schema.Vocabularies;
+import com.networknt.schema.Vocabulary;
+import com.networknt.schema.VocabularyFactory;
 import com.networknt.schema.Specification.Version;
 import com.networknt.schema.keyword.FormatKeyword;
 import com.networknt.schema.keyword.Keyword;
@@ -303,26 +315,6 @@ public Dialect build() {
             Map<String, Keyword> result = createKeywordsMap(keywords, this.formats);
             return new Dialect(this.iri, this.idKeyword, result, this.vocabularies, this.specification, this);
         }
-
-        @Deprecated
-        public Builder addKeyword(Keyword keyword) {
-            return keyword(keyword);
-        }
-
-        @Deprecated
-        public Builder addKeywords(Collection<? extends Keyword> keywords) {
-            return keywords(keywords);
-        }
-
-        @Deprecated
-        public Builder addFormat(Format format) {
-            return format(format);
-        }
-
-        @Deprecated
-        public Builder addFormats(Collection<? extends Format> formats) {
-            return formats(formats);
-        }
     }
 
     private final String iri;
@@ -352,34 +344,8 @@ public Builder addFormats(Collection<? extends Format> formats) {
         this.builder = builder;
     }
 
-    public static Dialect getV4() {
-        return new Version4().getInstance();
-    }
-
-    public static Dialect getV6() {
-        return new Version6().getInstance();
-    }
-
-    public static Dialect getV7() {
-        return new Version7().getInstance();
-    }
-
-    public static Dialect getV201909() {
-        return new Version201909().getInstance();
-    }
-
-    public static Dialect getV202012() {
-        return new Version202012().getInstance();
-    }
-
     /**
      * Create a builder without keywords or formats.
-     * <p>
-     * Use {@link #getV4()} for the Draft 4 Metaschema, or if you need a builder based on Draft4, use
-     *
-     * <code>
-     * JsonMetaSchema.builder("http://your-metaschema-iri", JsonMetaSchema.getV4()).build();
-     * </code>
      *
      * @param iri the IRI of the metaschema that will be defined via this builder.
      * @return a builder instance without any keywords or formats - usually not what one needs.

…java/com/networknt/schema/DialectId.java …/networknt/schema/dialect/DialectId.javasrc/main/java/com/networknt/schema/DialectId.java renamed to src/main/java/com/networknt/schema/dialect/DialectId.java src/main/java/com/networknt/schema/DialectId.java renamed to src/main/java/com/networknt/schema/dialect/DialectId.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.networknt.schema;
+package com.networknt.schema.dialect;
 
 /**
  * The dialect id is an IRI that points to the meta-schema that can be used to

src/main/java/com/networknt/schema/dialect/Dialects.java

@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.networknt.schema.dialect;
+
+/**
+ * The dialects.
+ */
+public class Dialects {
+    /**
+     * Draft 4.
+     * 
+     * @return the Draft 4 dialect
+     */
+    public static Dialect getDraft4() {
+        return Draft4.getInstance();
+    }
+
+    /**
+     * Draft 6.
+     * 
+     * @return the Draft 6 dialect
+     */
+    public static Dialect getDraft6() {
+        return Draft6.getInstance();
+    }
+
+    /**
+     * Draft 7.
+     * 
+     * @return the Draft 7 dialect
+     */
+    public static Dialect getDraft7() {
+        return Draft7.getInstance();
+    }
+
+    /**
+     * Draft 2019-09.
+     * 
+     * @return the Draft 2019-09 dialect
+     */
+    public static Dialect getDraft201909() {
+        return Draft201909.getInstance();
+    }
+
+    /**
+     * Draft 2020-12.
+     * 
+     * @return the Draft 2020-12 dialect
+     */
+    public static Dialect getDraft202012() {
+        return Draft202012.getInstance();
+    }
+
+    /**
+     * OpenAPI 3.0.
+     * 
+     * @return the OpenAPI 3.0 dialect
+     */
+    public static Dialect getOpenApi30() {
+        return OpenApi30.getInstance();
+    }
+
+    /**
+     * OpenAPI 3.1.
+     * 
+     * @return the OpenAPI 3.1 dialect
+     */
+    public static Dialect getOpenApi31() {
+        return OpenApi31.getInstance();
+    }
+}