Rename Specification.Version to SpecificationVersion and refactor

Author: justin-tay

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

@@ -31,7 +31,6 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
-import com.networknt.schema.Specification.Version;
 import com.networknt.schema.keyword.DiscriminatorValidator;
 import com.networknt.schema.keyword.KeywordValidator;
 import com.networknt.schema.keyword.TypeValidator;
@@ -51,7 +50,7 @@
  * modified.
  */
 public class Schema implements Validator {
-    private static final long DRAFT_2019_09_VALUE = Version.DRAFT_2019_09.getOrder();
+    private static final long DRAFT_2019_09_VALUE = SpecificationVersion.DRAFT_2019_09.getOrder();
     private final String id;
 
     /**
@@ -656,7 +655,7 @@ private List<KeywordValidator> read(JsonNode schemaNode) {
             }
 
             // Ignore siblings for older drafts
-            if (null != refValidator && getSchemaContext().getDialect().getSpecification().getOrder() < DRAFT_2019_09_VALUE) {
+            if (null != refValidator && getSchemaContext().getDialect().getSpecificationVersion().getOrder() < DRAFT_2019_09_VALUE) {
                 validators.clear();
                 validators.add(refValidator);
             }

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

@@ -16,12 +16,10 @@
 
 package com.networknt.schema;
 
-import java.util.Optional;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 
 import com.fasterxml.jackson.databind.JsonNode;
-import com.networknt.schema.Specification.Version;
 import com.networknt.schema.dialect.Dialect;
 import com.networknt.schema.keyword.KeywordValidator;
 

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

@@ -17,7 +17,6 @@
 package com.networknt.schema;
 
 import com.fasterxml.jackson.databind.JsonNode;
-import com.networknt.schema.Specification.Version;
 import com.networknt.schema.dialect.BasicDialectRegistry;
 import com.networknt.schema.dialect.DefaultDialectRegistry;
 import com.networknt.schema.dialect.Dialect;
@@ -174,7 +173,7 @@ public SchemaLoader getSchemaLoader() {
      * Builder without keywords or formats.
      * <p>
      * Typically {@link #builder(SchemaRegistry)} or
-     * {@link #withDefaultDialect(Version)} or {@link #withDialect(Dialect)} would be used instead.
+     * {@link #withDefaultDialect(SpecificationVersion)} or {@link #withDialect(Dialect)} would be used instead.
      *
      * @return a builder instance without any keywords or formats - usually not what
      *         one needs.
@@ -192,7 +191,7 @@ public static Builder builder() {
      *                             not specify the $schema keyword
      * @return the factory
      */
-    public static SchemaRegistry withDefaultDialect(Specification.Version specificationVersion) {
+    public static SchemaRegistry withDefaultDialect(SpecificationVersion specificationVersion) {
         return withDefaultDialect(specificationVersion, null);
     }
 
@@ -206,7 +205,7 @@ public static SchemaRegistry withDefaultDialect(Specification.Version specificat
      * @param customizer           to customize the registry
      * @return the factory
      */
-    public static SchemaRegistry withDefaultDialect(Specification.Version specificationVersion,
+    public static SchemaRegistry withDefaultDialect(SpecificationVersion specificationVersion,
             Consumer<SchemaRegistry.Builder> customizer) {
         Dialect dialect = Specification.getDialect(specificationVersion);
         return withDefaultDialectId(dialect.getId(), customizer);
@@ -628,7 +627,7 @@ private boolean isYaml(final SchemaLocation schemaUri) {
      */
     static protected String normalizeDialectId(String id) {
         boolean found = false;
-        for (Version flag : Specification.Version.values()) {
+        for (SpecificationVersion flag : SpecificationVersion.values()) {
             if(flag.getDialectId().equals(id)) {
                 found = true;
                 break;

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

@@ -0,0 +1,93 @@
+/*
+ * 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;
+
+import com.networknt.schema.dialect.DialectId;
+
+/**
+ * The version of the JSON Schema specification that defines the standard
+ * dialects.
+ */
+public enum SpecificationVersion {
+    /**
+     * Draft 4.
+     */
+    DRAFT_4(4, DialectId.DRAFT_4),
+    /**
+     * Draft 6.
+     */
+    DRAFT_6(6, DialectId.DRAFT_6),
+    /**
+     * Draft 7.
+     */
+    DRAFT_7(7, DialectId.DRAFT_7),
+    /**
+     * Draft 2019-09.
+     */
+    DRAFT_2019_09(8, DialectId.DRAFT_2019_09),
+    /**
+     * Draft 2020-12.
+     */
+    DRAFT_2020_12(9, DialectId.DRAFT_2020_12);
+
+    private final int order;
+    private final String dialectId;
+
+    SpecificationVersion(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<SpecificationVersion> fromDialectId(String dialectId) {
+        for (SpecificationVersion version : SpecificationVersion.values()) {
+            if (version.dialectId.equals(dialectId)) {
+                return Optional.of(version);
+            }
+        }
+        return Optional.empty();
+    }
+}