Rename SpecVersion.VersionFlag to Specification.Version and refactor

Author: justin-tay

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

@@ -19,7 +19,7 @@
 import java.util.Map.Entry;
 
 import com.fasterxml.jackson.databind.JsonNode;
-import com.networknt.schema.SpecVersion.VersionFlag;
+import com.networknt.schema.Specification.Version;
 
 /**
  * Default {@link JsonMetaSchemaFactory}.
@@ -28,7 +28,7 @@ public class DefaultJsonMetaSchemaFactory implements JsonMetaSchemaFactory {
     @Override
     public JsonMetaSchema getMetaSchema(String iri, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config) {
         // Is it a well-known dialect?
-        return SpecVersionDetector.detectOptionalVersion(iri)
+        return Specification.Version.fromDialectId(iri)
                 .map(JsonSchemaFactory::checkVersion)
                 .map(JsonSchemaVersion::getInstance)
                 .orElseGet(() -> {
@@ -55,9 +55,9 @@ protected JsonMetaSchema.Builder loadMetaSchemaBuilder(String iri, JsonSchemaFac
             SchemaValidatorsConfig config) {
         JsonSchema schema = schemaFactory.getSchema(SchemaLocation.of(iri), config);
         JsonMetaSchema.Builder builder = JsonMetaSchema.builder(iri, schema.getValidationContext().getMetaSchema());
-        VersionFlag specification = schema.getValidationContext().getMetaSchema().getSpecification();
+        Version specification = schema.getValidationContext().getMetaSchema().getSpecification();
         if (specification != null) {
-            if (specification.getVersionFlagValue() >= VersionFlag.V201909.getVersionFlagValue()) {
+            if (specification.getOrder() >= Version.DRAFT_2019_09.getOrder()) {
                 // Process vocabularies
                 JsonNode vocabulary = schema.getSchemaNode().get("$vocabulary");
                 if (vocabulary != null) {

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

@@ -17,7 +17,7 @@
 package com.networknt.schema;
 
 import com.fasterxml.jackson.databind.JsonNode;
-import com.networknt.schema.SpecVersion.VersionFlag;
+import com.networknt.schema.Specification.Version;
 import com.networknt.schema.keyword.FormatKeyword;
 import com.networknt.schema.keyword.Keyword;
 import com.networknt.schema.keyword.KeywordFactory;
@@ -61,7 +61,7 @@ public interface FormatKeywordFactory {
     public static class Builder {
         private String iri;
         private String idKeyword = "$id";
-        private VersionFlag specification = null;
+        private Version specification = null;
         private final Map<String, Keyword> keywords = new HashMap<>();
         private final Map<String, Format> formats = new HashMap<>();
         private final Map<String, Boolean> vocabularies = new HashMap<>();
@@ -253,7 +253,7 @@ public Builder vocabularies(Consumer<Map<String, Boolean>> customizer) {
          * @param specification the specification
          * @return the builder
          */
-        public Builder specification(VersionFlag specification) {
+        public Builder specification(Version specification) {
             this.specification = specification;
             return this;
         }
@@ -273,7 +273,7 @@ public JsonMetaSchema build() {
             // create builtin keywords with (custom) formats.
             Map<String, Keyword> keywords = this.keywords;
             if (this.specification != null) {
-                if (this.specification.getVersionFlagValue() >= SpecVersion.VersionFlag.V201909.getVersionFlagValue()) {
+                if (this.specification.getOrder() >= Specification.Version.DRAFT_2019_09.getOrder()) {
                     keywords = new HashMap<>(this.keywords);
                     for(Entry<String, Boolean> entry : this.vocabularies.entrySet()) {
                         Vocabulary vocabulary = null;
@@ -326,11 +326,11 @@ public Builder addFormats(Collection<? extends Format> formats) {
     private final String idKeyword;
     private final Map<String, Keyword> keywords;
     private final Map<String, Boolean> vocabularies;
-    private final VersionFlag specification;
+    private final Version specification;
 
     private final Builder builder;
 
-    JsonMetaSchema(String iri, String idKeyword, Map<String, Keyword> keywords, Map<String, Boolean> vocabularies, VersionFlag specification, Builder builder) {
+    JsonMetaSchema(String iri, String idKeyword, Map<String, Keyword> keywords, Map<String, Boolean> vocabularies, Version specification, Builder builder) {
         if (StringUtils.isBlank(iri)) {
             throw new IllegalArgumentException("iri must not be null or blank");
         }
@@ -461,7 +461,7 @@ public Map<String, Boolean> getVocabularies() {
         return this.vocabularies;
     }
 
-    public VersionFlag getSpecification() {
+    public Version getSpecification() {
         return this.specification;
     }
 

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

@@ -31,7 +31,7 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
-import com.networknt.schema.SpecVersion.VersionFlag;
+import com.networknt.schema.Specification.Version;
 import com.networknt.schema.keyword.DiscriminatorValidator;
 import com.networknt.schema.keyword.KeywordValidator;
 import com.networknt.schema.keyword.TypeValidator;
@@ -40,7 +40,7 @@
 
 /**
  * Used for creating a schema with validators for validating inputs. This is
- * created using {@link JsonSchemaFactory#getInstance(VersionFlag, Consumer)}
+ * created using {@link JsonSchemaFactory#getInstance(Version, Consumer)}
  * and should be cached for performance.
  * <p>
  * This is the core of json constraint implementation. It parses json constraint
@@ -51,7 +51,7 @@
  * modified.
  */
 public class JsonSchema implements Validator {
-    private static final long V201909_VALUE = VersionFlag.V201909.getVersionFlagValue();
+    private static final long V201909_VALUE = Version.DRAFT_2019_09.getOrder();
     private final String id;
 
     /**
@@ -673,8 +673,8 @@ private List<KeywordValidator> read(JsonNode schemaNode) {
     private long activeDialect() {
         return this.validationContext
             .activeDialect()
-            .map(VersionFlag::getVersionFlagValue)
-            .orElse(Long.MAX_VALUE);
+            .map(Version::getOrder)
+            .orElse(Integer.MAX_VALUE);
     }
 
     /**

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

@@ -18,7 +18,7 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.networknt.schema.SpecVersion.VersionFlag;
+import com.networknt.schema.Specification.Version;
 import com.networknt.schema.resource.DefaultSchemaLoader;
 import com.networknt.schema.resource.SchemaLoader;
 import com.networknt.schema.resource.SchemaLoaders;
@@ -43,7 +43,7 @@
 
 /**
  * Factory for building {@link JsonSchema} instances. The factory should be
- * typically be created using {@link #getInstance(VersionFlag, Consumer)} and
+ * typically be created using {@link #getInstance(Version, Consumer)} and
  * should be cached for performance.
  * <p>
  * JsonSchemaFactory instances are thread-safe provided its configuration is not
@@ -251,7 +251,7 @@ public static Builder builder() {
      * @param versionFlag the default dialect
      * @return the factory
      */
-    public static JsonSchemaFactory getInstance(SpecVersion.VersionFlag versionFlag) {
+    public static JsonSchemaFactory getInstance(Specification.Version versionFlag) {
         return getInstance(versionFlag, null);
     }
 
@@ -263,7 +263,7 @@ public static JsonSchemaFactory getInstance(SpecVersion.VersionFlag versionFlag)
      * @param customizer to customize the factory
      * @return the factory
      */
-    public static JsonSchemaFactory getInstance(SpecVersion.VersionFlag versionFlag,
+    public static JsonSchemaFactory getInstance(Specification.Version versionFlag,
             Consumer<JsonSchemaFactory.Builder> customizer) {
         JsonSchemaVersion jsonSchemaVersion = checkVersion(versionFlag);
         JsonMetaSchema metaSchema = jsonSchemaVersion.getInstance();
@@ -283,14 +283,14 @@ public static JsonSchemaFactory getInstance(SpecVersion.VersionFlag versionFlag,
      * @param versionFlag the schema dialect
      * @return the version
      */
-    public static JsonSchemaVersion checkVersion(SpecVersion.VersionFlag versionFlag){
+    public static JsonSchemaVersion checkVersion(Specification.Version versionFlag){
         if (null == versionFlag) return null;
         switch (versionFlag) {
-            case V202012: return new Version202012();
-            case V201909: return new Version201909();
-            case V7: return new Version7();
-            case V6: return new Version6();
-            case V4: return new Version4();
+            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);
         }
     }
@@ -822,8 +822,8 @@ private boolean isYaml(final SchemaLocation schemaUri) {
      */
     static protected String normalizeMetaSchemaUri(String id) {
         boolean found = false;
-        for (VersionFlag flag : SpecVersion.VersionFlag.values()) {
-            if(flag.getId().equals(id)) {
+        for (Version flag : Specification.Version.values()) {
+            if(flag.getDialectId().equals(id)) {
                 found = true;
                 break;
             }

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

@@ -0,0 +1,96 @@
+/*
+ * Copyright (c) 2020 Network New Technologies Inc.
+ *
+ * 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;
+
+import java.util.Optional;
+
+/**
+ * The JSON Schema specification which defines the standard dialects.
+ */
+public class Specification {
+
+    /**
+     * The JSON Schema specification version.
+     */
+    public enum Version {
+        /**
+         * Draft 4.
+         */
+        DRAFT_4(4, SchemaId.V4),
+        /**
+         * Draft 6.
+         */
+        DRAFT_6(6, SchemaId.V6),
+        /**
+         * Draft 7.
+         */
+        DRAFT_7(7, SchemaId.V7),
+        /**
+         * Draft 2019-09.
+         */
+        DRAFT_2019_09(8, SchemaId.V201909),
+        /**
+         * Draft 2020-12.
+         */
+        DRAFT_2020_12(9, SchemaId.V202012);
+
+        private final int order;
+        private final String dialectId;
+
+        Version(int order, String dialectId) {
+            this.order = order;
+            this.dialectId = dialectId;
+        }
+
+        /**
+         * Gets the dialect id used for the $schema keyword. The dialect id is an IRI
+         * that identifies the meta schema used to validate the dialect.
+         * 
+         * @return the dialect id
+         */
+        public String getDialectId() {
+            return this.dialectId;
+        }
+
+        /**
+         * Gets the unique release order of the specification version used that
+         * indicates when the specification was released. Lower numbers indicate the
+         * specification was released earlier.
+         *
+         * @return the order when the specification was released
+         */
+        public int getOrder() {
+            return this.order;
+        }
+
+        /**
+         * Gets the specification version that matches the dialect id indicated by
+         * $schema keyword. The dialect id is an IRI that identifies the meta schema
+         * used to validate the dialect.
+         *
+         * @param dialectId the dialect id specified by $schema keyword
+         * @return the specification version if it matches the dialect id
+         */
+        public static Optional<Version> fromDialectId(String dialectId) {
+            for (Version version : Version.values()) {
+                if (version.dialectId.equals(dialectId)) {
+                    return Optional.of(version);
+                }
+            }
+            return Optional.empty();
+        }
+    }
+}